Debian Codegraph @

upstream/mageia-cauldron/man5/muttrc.5

raw
1 '\" t
2 .\" -*-nroff-*-
3 .\"
4 .\" Copyright (C) 1996-2000 Michael R. Elkins <[email protected]>
5 .\" Copyright (C) 1999-2000 Thomas Roessler <[email protected]>
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 .de EX
22 .nf
23 .ft CW
24 ..
25 .de EE
26 .ft
27 .fi
28 ..
29 .TH muttrc 5 "January 2019" Unix "User Manuals"
30 .SH NAME
31 muttrc \- Configuration file for the Mutt Mail User Agent
32 .SH DESCRIPTION
33 .PP
34 A mutt configuration file consists of a series of \(lqcommands\(rq.
35 Each line of the file may contain one or more commands. When
36 multiple commands are used, they must be separated by a semicolon
37 (\(lq\fB;\fP\(rq).
38 .PP
39 The hash mark, or pound sign (\(lq\fB#\fP\(rq), is used as a
40 \(lqcomment\(rq character. You can use it to annotate your
41 initialization file. All text after the comment character to the end
42 of the line is ignored.
43 .PP
44 Single quotes (\(lq\fB'\fP\(rq) and double quotes (\(lq\fB"\fP\(rq)
45 can be used to quote strings which contain spaces or other special
46 characters. The difference between the two types of quotes is
47 similar to that of many popular shell programs, namely that a single
48 quote is used to specify a literal string (one that is not
49 interpreted for shell variables or quoting with a backslash [see
50 next paragraph]), while double quotes indicate a string which
51 should be evaluated. For example, backticks are evaluated inside of
52 double quotes, but not single quotes.
53 .PP
54 \fB\(rs\fP quotes the next character, just as in shells such as bash and zsh.
55 For example, if want to put quotes (\(lq\fB"\fP\(rq) inside of a
56 string, you can use \(lq\fB\(rs\fP\(rq to force the next character
57 to be a literal instead of interpreted character.
58 .PP
59 \(lq\fB\(rs\(rs\fP\(rq means to insert a literal \(lq\fB\(rs\fP\(rq into the
60 line. \(lq\fB\(rsn\fP\(rq and \(lq\fB\(rsr\fP\(rq have their usual
61 C meanings of linefeed and carriage-return, respectively.
62 .PP
63 A \(lq\fB\(rs\fP\(rq at the end of a line can be used to split commands over
64 multiple lines, provided that the split points don't appear in the
65 middle of command names.
66 .PP
67 It is also possible to substitute the output of a Unix command in an
68 initialization file. This is accomplished by enclosing the command
69 in backticks (\fB`\fP\fIcommand\fP\fB`\fP).
70 .PP
71 UNIX environment variables can be accessed like the way it is done in shells
72 like sh and bash: Prepend the name of the variable by a dollar
73 (\(lq\fB\(Do\fP\(rq) sign.
74 .
75 .
76 .PP
77 .SH COMMANDS
78 .
79 .PP
80 .nf
81 \fBalias\fP [\fB-group\fP \fIname\fP [...]] \fIkey\fP \fIaddress\fP [\fB,\fP \fIaddress\fP [ ... ]]
82 \fBunalias\fP [\fB * \fP | \fIkey\fP ]
83 .fi
84 .IP
85 \fBalias\fP defines an alias \fIkey\fP for the given addresses. Each
86 \fIaddress\fP will be resolved into either an email address ([email protected])
87 or a named email address (User Name <[email protected]>). The address may be specified in either format, or in the format \([email protected] (User
88 Name)\(rq.
89 \fBunalias\fP removes the alias corresponding to the given \fIkey\fP or
90 all aliases when \(lq\fB*\fP\(rq is used as an argument. The optional
91 \fB-group\fP argument to \fBalias\fP causes the aliased address(es) to be
92 added to the named \fIgroup\fP.
93 .
94 .PP
95 .nf
96 \fBgroup\fP [\fB-group\fP \fIname\fP] [\fB-rx\fP \fIEXPR\fP [ \fI...\fP ]] [\fB-addr\fP \fIaddress\fP [ \fI...\fP ]]
97 \fBungroup\fP [\fB-group\fP \fIname\fP ] [ \fB*\fP | [[\fB-rx\fP \fIEXPR\fP [ \fI...\fP ]] [\fB-addr\fP \fIaddress\fP [ \fI...\fP ]]]
98 .fi
99 .IP
100 \fBgroup\fP is used to directly add either addresses or regular expressions to
101 the specified group or groups. The different categories of arguments to the
102 \fBgroup\fP command can be in any order. The flags \fI-rx\fP and \fI-addr\fP
103 specify what the following strings (that cannot begin with a hyphen) should be
104 interpreted as: either a regular expression or an email address, respectively.
105 \fBungroup\fP is used to remove addresses or regular expressions from the
106 specified group or groups. The syntax is similar to the \fBgroup\fP command,
107 however the special character \fB*\fP can be used to empty a group of all of
108 its contents.
109 .IP
110 These address groups can also be created implicitly by the \fBalias\fP, \fBlists\fP,
111 \fBsubscribe\fP and \fBalternates\fP commands by specifying the optional \fI-group\fP
112 option.
113 .IP
114 Once defined, these address groups can be used in patterns to search for and limit the
115 display to messages matching a group.
116 .
117 .PP
118 .nf
119 \fBalternates\fP [\fB-group\fP \fIname\fP] \fIregexp\fP [ \fIregexp\fP [ ... ]]
120 \fBunalternates\fP [\fB * \fP | \fIregexp\fP [ \fIregexp\fP [ ... ]] ]
121 .fi
122 .IP
123 \fBalternates\fP is used to inform mutt about alternate addresses
124 where you receive mail; you can use regular expressions to specify
125 alternate addresses. This affects mutt's idea about messages
126 from you, and messages addressed to you. \fBunalternates\fP removes
127 a regular expression from the list of known alternates. The \fB-group\fP flag
128 causes all of the subsequent regular expressions to be added to the named group.
129 .
130 .PP
131 .nf
132 \fBalternative_order\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
133 \fBunalternative_order\fP [\fB * \fP | \fItype\fP/\fIsubtype\fP] [...]
134 .fi
135 .IP
136 \fBalternative_order\fP command permits you to define an order of preference which is
137 used by mutt to determine which part of a
138 \fBmultipart/alternative\fP body to display.
139 A subtype of \(lq\fB*\fP\(rq matches any subtype, as does an empty
140 subtype. \fBunalternative_order\fP removes entries from the
141 ordered list or deletes the entire list when \(lq\fB*\fP\(rq is used
142 as an argument.
143 .
144 .PP
145 .nf
146 \fBattachments\fP [ \fB+\fP | \fB-\fP ]\fIdisposition\fP \fImime-type\fP
147 \fBunattachments\fP [ \fB+\fP | \fB-\fP ]\fIdisposition\fI \fImime-type\fP
148 \fBattachments\fP \fB?\fP
149 \fBunattachments\fP \fB*\fP
150 .fi
151 .IP
152 \fBattachments\fP specifies what kinds of attachments are used for Mutt's
153 attachment counting and searching support.
154 .IP
155 \fIdisposition\fP is the attachment's Content-Disposition type - either
156 inline or attachment. You can abbreviate this to I or A.
157 .IP
158 The first part of a message or multipart group, if inline, is counted
159 separately than other inline parts. Specify root or R for disposition
160 to count these as attachments. If this first part is of type
161 multipart/alternative, note that its top-level inline parts are also
162 counted via root disposition (if $count_alternatives is set).
163 .IP
164 \fIdisposition\fP is prefixed by either a \fB+\fP symbol or a \fB-\fP
165 symbol. If it's a \fB+\fP, you're saying that you want to allow this
166 disposition and MIME type to qualify. If it's a \fB-\fP, you're saying
167 that this disposition and MIME type is an exception to previous \fB+\fP
168 rules.
169 .IP
170 \fImime-type\fP is the MIME type of the attachment you want the
171 command to affect. A MIME type is always of the format major/minor,
172 where major describes the broad category of document you're looking
173 at, and minor describes the specific type within that category. The
174 major part of mime-type must be literal text (or the special token
175 \fB*\fP), but the minor part may be a regular expression. (Therefore,
176 \fB*/.*\fP matches any MIME type.)
177 .IP
178 The MIME types you give to the attachments directive are a kind of
179 pattern. When you use the attachments directive, the patterns you
180 specify are added to a list. When you use unattachments, the pattern
181 is removed from the list. The patterns are not expanded and matched to
182 specific MIME types at this time - they're just text in a
183 list. They're only matched when actually evaluating a message.
184 .
185 .PP
186 .nf
187 \fBauto_view\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
188 \fBunauto_view\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
189 .fi
190 .IP
191 This commands permits you to specify that mutt should automatically
192 convert the given MIME types to text/plain when displaying messages.
193 For this to work, there must be a
194 .BR mailcap (5)
195 entry for the given MIME type with the
196 .B copiousoutput
197 flag set. A subtype of \(lq\fB*\fP\(rq
198 matches any subtype, as does an empty subtype.
199 .
200 .PP
201 .nf
202 \fBmime_lookup\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
203 \fBunmime_lookup\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
204 .fi
205 .IP
206 This command permits you to define a list of "data" MIME content
207 types for which mutt will try to determine the actual file type from
208 the file name, and not use a
209 .BR mailcap (5)
210 entry given for the original MIME type. For instance, you may add
211 the \fBapplication/octet-stream\fP MIME type to this list.
212 .
213 .TP
214 \fBbind\fP \fImap1,map2,...\fP \fIkey\fP \fIfunction\fP
215 This command binds the given \fIkey\fP for the given \fImap\fP or maps
216 to the given \fIfunction\fP. Multiple maps may be specified by
217 separating them with commas (no whitespace is allowed).
218 .IP
219 Valid maps are:
220 .BR generic ", " alias ", " attach ", "
221 .BR browser ", " editor ", "
222 .BR index ", " compose ", "
223 .BR pager ", " pgp ", " postpone ", "
224 .BR mix .
225 .IP
226 For more information on keys and functions, please consult the Mutt
227 Manual. Note that the function name is to be specified without
228 angle brackets.
229 .
230 .TP
231 \fBaccount-hook\fP [\fB!\fP]\fIregexp\fP \fIcommand\fP
232 This hook is executed whenever you access a remote mailbox. Useful
233 to adjust configuration settings to different IMAP or POP servers.
234 .
235 .TP
236 \fBcharset-hook\fP \fIalias\fP \fIcharset\fP
237 This command defines an alias for a character set. This is useful
238 to properly display messages which are tagged with a character set
239 name not known to mutt.
240 .
241 .TP
242 \fBiconv-hook\fP \fIcharset\fP \fIlocal-charset\fP
243 This command defines a system-specific name for a character set.
244 This is useful when your system's
245 .BR iconv (3)
246 implementation does not understand MIME character set names (such as
247 .BR iso-8859-1 ),
248 but instead insists on being fed with implementation-specific
249 character set names (such as
250 .BR 8859-1 ).
251 In this specific case, you'd put this into your configuration file:
252 .IP
253 .B "iconv-hook iso-8859-1 8859-1"
254 .
255 .TP
256 \fBmessage-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
257 Before mutt displays (or formats for replying or forwarding) a
258 message which matches the given \fIpattern\fP (or, when it is
259 preceded by an exclamation mark, does not match the \fIpattern\fP),
260 the given \fIcommand\fP is executed. When multiple
261 \fBmessage-hook\fPs match, they are executed in the order in
262 which they occur in the configuration file.
263 .
264 .TP
265 \fBfolder-hook\fP [\fB!\fP]\fIregexp\fP \fIcommand\fP
266 When mutt enters a folder which matches \fIregexp\fP (or, when
267 \fIregexp\fP is preceded by an exclamation mark, does not match
268 \fIregexp\fP), the given \fIcommand\fP is executed.
269 .IP
270 When several \fBfolder-hook\fPs match a given mail folder, they are
271 executed in the order given in the configuration file.
272 .
273 .TP
274 \fBmacro\fP \fImap\fP \fIkey\fP \fIsequence\fP [ \fIdescription\fP ]
275 This command binds the given \fIsequence\fP of keys to the given
276 \fIkey\fP in the given \fImap\fP or maps. For valid maps, see \fBbind\fP. To
277 specify multiple maps, put only a comma between the maps.
278 .PP
279 .nf
280 \fBcolor\fP \fIobject\fP [ \fIattribute\fP ... ] \fIforeground\fP \fIbackground\fP [ \fIregexp\fP ]
281 \fBcolor\fP index [ \fIattribute\fP ... ] \fIforeground\fP \fIbackground\fP [ \fIpattern\fP ]
282 \fBcolor\fP compose \fIcomposeobject\fP [ \fIattribute\fP ... ] \fIforeground\fP \fIbackground\fP
283 \fBuncolor\fP index \fIpattern\fP [ \fIpattern\fP ... ]
284 .fi
285 .IP
286 If your terminal supports color, these commands can be used to
287 assign \fIforeground\fP/\fIbackground\fP combinations to certain
288 objects. Valid objects are:
289 .BR attachment ", " body ", " bold ", " error ", " header ", "
290 .BR hdrdefault ", " index ", " indicator ", " markers ", "
291 .BR message ", " normal ", " prompt ", " quoted ", " quoted\fIN\fP ", "
292 .BR search ", " signature ", " status ", " tilde ", " tree ", "
293 .BR underline .
294 If the sidebar is enabled the following objects are also valid:
295 .BR sidebar_divider ", " sidebar_flagged ", " sidebar_highlight ", "
296 .BR sidebar_indicator ", " sidebar_new ", " sidebar_spoolfile .
297 The
298 .BR body " and " header
299 objects allow you to restrict the colorization to a regular
300 expression. The \fBindex\fP object permits you to select colored
301 messages by pattern.
302 .IP
303 Valid composeobjects include
304 .BR header ", " security_encrypt ", " security_sign ", "
305 .BR security_both ", " security_none .
306 .IP
307 Valid colors include:
308 .BR white ", " black ", " green ", " magenta ", " blue ", "
309 .BR cyan ", " yellow ", " red ", " default ", " color\fIN\fP .
310 .IP
311 Valid attributes include:
312 .BR none ", " bold ", " underline ", "
313 .BR reverse ", and " standout .
314 .
315 .PP
316 .nf
317 \fBmono\fP \fIobject\fP \fIattribute\fP [ \fIregexp\fP ]
318 \fBmono\fP index \fIattribute\fP [ \fIpattern\fP ]
319 .fi
320 .IP
321 For terminals which don't support color, you can still assign
322 attributes to objects.
323 .
324 .TP
325 [\fBun\fP]\fBignore\fP \fIpattern\fP [ \fIpattern\fP ... ]
326 The \fBignore\fP command permits you to specify header fields which
327 you usually don't wish to see. Any header field whose tag
328 \fIbegins\fP with an \(lqignored\(rq pattern will be ignored.
329 .IP
330 The \fBunignore\fP command permits you to define exceptions from
331 the above mentioned list of ignored headers.
332 .
333 .PP
334 .nf
335 \fBlists\fP [\fB-group\fP \fIname\fP] \fIregexp\fP [ \fIregexp\fP ... ]
336 \fBunlists\fP \fIregexp\fP [ \fIregexp\fP ... ]
337 \fBsubscribe\fP [\fB-group\fP \fIname\fP] \fIregexp\fP [ \fIregexp\fP ... ]
338 \fBunsubscribe\fP \fIregexp\fP [ \fIregexp\fP ... ]
339 .fi
340 .IP
341 Mutt maintains two lists of mailing list address patterns, a list of
342 subscribed mailing lists, and a list of known mailing lists. All
343 subscribed mailing lists are known. Patterns use regular expressions.
344 .IP
345 The \fBlists\fP command adds a mailing list address to the list of
346 known mailing lists. The \fBunlists\fP command removes a mailing
347 list from the lists of known and subscribed mailing lists. The
348 \fBsubscribe\fP command adds a mailing list to the lists of known
349 and subscribed mailing lists. The \fBunsubscribe\fP command removes
350 it from the list of subscribed mailing lists. The \fB-group\fP flag
351 adds all of the subsequent regular expressions to the named group.
352 .
353 .TP
354 \fBmbox-hook\fP [\fB!\fP]\fIregexp\fP \fImailbox\fP
355 When mutt changes to a mail folder which matches \fIregexp\fP,
356 \fImailbox\fP will be used as the \(lqmbox\(rq folder, i.e., read
357 messages will be moved to that folder when the mail folder is left.
358 .IP
359 The first matching \fBmbox-hook\fP applies.
360 .
361 .PP
362 .nf
363 \fBmailboxes\fP [[\fB-notify\fP | \fB-nonotify\fP]
364 [\fB-poll\fP | \fB-nopoll\fP]
365 [[\fB-label\fP \fIlabel\fP] | \fB-nolabel\fP]
366 \fIfilename\fP] [ ... ]
367 \fBunmailboxes\fP [ \fB*\fP | \fIfilename\fP ... ]
368 .fi
369 .IP
370 The \fBmailboxes\fP specifies folders which can receive mail and which will
371 be checked for new messages. When changing folders, pressing space
372 will cycle through folders with new mail. The \fBunmailboxes\fP
373 command is used to remove a file name from the list of folders which
374 can receive mail. If "\fB*\fP" is specified as the file name, the
375 list is emptied.
376 .
377 .PP
378 .nf
379 \fBmy_hdr\fP \fIstring\fP
380 \fBunmy_hdr\fP \fIfield\fP
381 .fi
382 .IP
383 Using \fBmy_hdr\fP, you can define headers which will be added to
384 the messages you compose. \fBunmy_hdr\fP will remove the given
385 user-defined headers.
386 .
387 .TP
388 \fBhdr_order\fP \fIheader1\fP \fIheader2\fP [ ... ]
389 With this command, you can specify an order in which mutt will
390 attempt to present headers to you when viewing messages.
391 .
392 .TP
393 \fBsave-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP
394 When a message matches \fIpattern\fP, the default file name when
395 saving it will be the given \fIfilename\fP.
396 .
397 .TP
398 \fBfcc-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP
399 When an outgoing message matches \fIpattern\fP, the default file
400 name for storing a copy (fcc) will be the given \fIfilename\fP.
401 .
402 .TP
403 \fBfcc-save-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP
404 This command is an abbreviation for identical \fBfcc-hook\fP and
405 \fBsave-hook\fP commands.
406 .
407 .TP
408 \fBsend-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
409 When composing a message matching \fIpattern\fP, \fIcommand\fP is
410 executed. When multiple \fBsend-hook\fPs match, they are executed
411 in the order in which they occur in the configuration file.
412 .
413 .TP
414 \fBsend2-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
415 Whenever a message matching \fIpattern\fP is changed (either by
416 editing it or by using the compose menu), \fIcommand\fP
417 is executed. When multiple \fBsend2-hook\fPs match, they are
418 executed in the order in which they occur in the configuration file.
419 Possible applications include setting the $sendmail variable when a
420 message's from header is changed.
421 .IP
422 \fBsend2-hook\fP execution is not triggered by use of
423 \fBenter-command\fP from the compose menu.
424 .
425 .TP
426 \fBreply-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
427 When replying to a message matching \fIpattern\fP, \fIcommand\fP is
428 executed. When multiple \fBreply-hook\fPs match, they are executed
429 in the order in which they occur in the configuration file, but all
430 \fBreply-hook\fPs are matched and executed before \fBsend-hook\fPs,
431 regardless of their order in the configuration file.
432 .
433 .TP
434 \fBcrypt-hook\fP \fIregexp\fP \fIkey-id\fP
435 The crypt-hook command provides a method by which you can
436 specify the ID of the public key to be used when encrypting messages
437 to a certain recipient. The meaning of "key ID" is to be taken
438 broadly: This can be a different e-mail address, a numerical key ID,
439 or even just an arbitrary search string.
440 You may use multiple
441 \fBcrypt-hook\fPs with the same \fIregexp\fP; multiple matching
442 \fBcrypt-hook\fPs result in the use of multiple \fIkey-id\fPs for
443 a recipient.
444 .
445 .TP
446 \fBindex-format-hook\fP \fIname\fP [\fB!\fP]\fIpattern\fP \fIformat-string\fP
447 This command is used to inject format strings dynamically into
448 $index_format based on pattern matching against the current message.
449 .IP
450 The $index_format expando \fI%@name@\fP specifies a placeholder for
451 the injection. Index-format-hooks with the same \fIname\fP are matched
452 using \fIpattern\fP against the current message. Matching is done in
453 the order specified in the .muttrc, with the first match being
454 used. The hook's \fIformat-string\fP is then substituted and evaluated.
455 .
456 .PP
457 .nf
458 \fBopen-hook\fP \fIregexp\fP "\fIcommand\fP"
459 \fBclose-hook\fP \fIregexp\fP "\fIcommand\fP"
460 \fBappend-hook\fP \fIregexp\fP "\fIcommand\fP"
461 .fi
462 .IP
463 These commands provide a way to handle compressed folders. The given
464 \fBregexp\fP specifies which folders are taken as compressed (e.g.
465 "\fI\\\\.gz$\fP"). The commands tell Mutt how to uncompress a folder
466 (\fBopen-hook\fP), compress a folder (\fBclose-hook\fP) or append a
467 compressed mail to a compressed folder (\fBappend-hook\fP). The
468 \fIcommand\fP string is the
469 .BR printf (3)
470 like format string, and it should accept two parameters: \fB%f\fP,
471 which is replaced with the (compressed) folder name, and \fB%t\fP
472 which is replaced with the name of the temporary folder to which to
473 write.
474 .
475 .PP
476 .nf
477 \fBpush\fP \fIstring\fP
478 \fBexec\fP \fIfunction\fP [ ... ]
479 .fi
480 .IP
481 \fBpush\fP adds the named \fIstring\fP to the keyboard buffer.
482 \(lqexec function\(rq is equivalent to \(lqpush <function>\(rq.
483 .
484 .TP
485 \fBrun\fP \fIMuttLisp\fP
486 .IP
487 The \fBrun\fP command evaluates the \fIMuttLisp\fP argument. The
488 output of the \fIMuttLisp\fP is then executed as a Mutt command, as if it
489 were typed in the muttrc instead.
490 .
491 .PP
492 .nf
493 \fBscore\fP \fIpattern\fP \fIvalue\fP
494 \fBunscore\fP [ \fB*\fP | \fIpattern\fP ... ]
495 .fi
496 .IP
497 The \fBscore\fP commands adds \fIvalue\fP to a message's score if
498 \fIpattern\fP matches it. The \fBunscore\fP command removes score
499 entries from the list.
500 .
501 .PP
502 .nf
503 \fBset\fP [\fBno\fP|\fBinv\fP|\fB&\fP|\fB?\fP]\fIvariable\fP[=\fIvalue\fP] [ ... ]
504 \fBtoggle\fP \fIvariable\fP [ ... ]
505 \fBunset\fP \fIvariable\fP [ ... ]
506 \fBreset\fP \fIvariable\fP [ ... ]
507 .fi
508 .IP
509 These commands are used to set and manipulate configuration
510 variables.
511 .IP
512 Mutt knows four basic types of variables: boolean, number, string
513 and quadoption. Boolean variables can be \fBset\fP (true),
514 \fBunset\fP (false), or \fBtoggle\fPd. Number variables can be assigned
515 a positive integer value.
516 .IP
517 String variables consist of any number of printable characters.
518 Strings must be enclosed in quotes if they contain spaces or tabs.
519 You may also use the \(lqC\(rq escape sequences \fB\\n\fP and
520 \fB\\t\fP for newline and tab, respectively.
521 .IP
522 Quadoption variables are used to control whether or not to be
523 prompted for certain actions, or to specify a default action. A
524 value of \fByes\fP will cause the action to be carried out automatically
525 as if you had answered yes to the question. Similarly, a value of
526 \fBno\fP will cause the action to be carried out as if you had
527 answered \(lqno.\(rq A value of \fBask-yes\fP will cause a prompt
528 with a default answer of \(lqyes\(rq and \fBask-no\fP will provide a
529 default answer of \(lqno.\(rq
530 .IP
531 The \fBreset\fP command resets all given variables to the compile
532 time defaults. If you reset the special variable \fBall\fP, all
533 variables will reset to their compile time defaults.
534 .
535 .PP
536 .nf
537 \fBsetenv\fP [\fB?\fP]\fIvariable\fP [ \fIvalue\fP ]
538 \fBunsetenv\fP \fIvariable\fP
539 .fi
540 .IP
541 These alter the environment that Mutt passes on to its child
542 processes. You can also query current environment values by prefixing
543 a “?” character.
544 .
545 .PP
546 .nf
547 \fBsidebar_whitelist\fP \fImailbox\fP [ \fImailbox\fP ...]
548 \fBunsidebar_whitelist\fP [ \fB*\fP | \fImailbox\fP ... ]
549 .fi
550 .IP
551 \fBsidebar_whitelist\fP specifies mailboxes that will always be
552 displayed in the sidebar, even if $sidebar_new_mail_only is set and
553 the mailbox does not contain new mail.
554 .IP
555 \fBunsidebar_whitelist\fP is used to remove a mailbox from the list of
556 whitelisted mailboxes. Use \fBunsidebar_whitelist *\fP to remove all
557 mailboxes.
558 .
559 .TP
560 \fBsource\fP \fIfilename\fP
561 The given file will be evaluated as a configuration file.
562 .
563 .PP
564 .nf
565 \fBspam\fP \fIpattern\fP \fIformat\fP
566 \fBnospam\fP \fIpattern\fP
567 .fi
568 .IP
569 These commands define spam-detection patterns from external spam
570 filters, so that mutt can sort, limit, and search on
571 ``spam tags'' or ``spam attributes'', or display them
572 in the index. See the Mutt manual for details.
573 .
574 .PP
575 .nf
576 \fBsubjectrx\fP \fIpattern\fP \fIreplacement\fP
577 \fBunsubjectrx\fP [ \fB*\fP | \fIpattern\fP ]
578 .fi
579 .IP
580 \fBsubjectrx\fP specifies a regular expression \fIpattern\fP which, if
581 detected in a message subject, causes the subject to be replaced with
582 the \fIreplacement\fP value. The \fIreplacement\fP is subject to
583 substitutions in the same way as for the \fBspam\fP command: %L for
584 the text to the left of the match, %R for text to the right of the
585 match, and %1 for the first subgroup in the match (etc). If you simply
586 want to erase the match, set it to \(lq%L%R\(rq. Any number of
587 \fBsubjectrx\fP commands may coexist.
588 .IP
589 Note this well: the \fIreplacement\fP value replaces the entire
590 subject, not just the match!
591 .IP
592 \fBunsubjectrx\fP removes a given \fBsubjectrx\fP from the
593 substitution list. If \fB*\fP is used as the pattern, all
594 substitutions will be removed.
595 .
596 .TP
597 \fBunhook\fP [\fB * \fP | \fIhook-type\fP ]
598 This command will remove all hooks of a given type, or all hooks
599 when \(lq\fB*\fP\(rq is used as an argument. \fIhook-type\fP
600 can be any of the \fB-hook\fP commands documented above.
601 .
602 .PP
603 .nf
604 \fBmailto_allow\fP \fIheader-field\fP [ ... ]
605 \fBunmailto_allow\fP [ \fB*\fP | \fIheader-field\fP ... ]
606 .fi
607 .IP
608 These commands allow the user to modify the list of allowed header
609 fields in a \fImailto:\fP URL that Mutt will include in the
610 the generated message. By default the list contains only
611 \fBsubject\fP and \fBbody\fP, as specified by RFC2368.
612 .
613 .TP
614 \fBecho\fP \fImessage\fP
615 Prints \fImessage\fP to the message window. After printing the
616 message, echo will pause for the number of seconds specified by
617 $sleep_time.
618 .
619 .TP
620 \fBcd\fP \fIdirectory\fP
621 Changes the current working directory.
622 .
623 .
624 .SH PATTERNS
625 .PP
626 In various places with mutt, including some of the above mentioned
627 \fBhook\fP commands, you can specify patterns to match messages.
628 .SS Constructing Patterns
629 .PP
630 A simple pattern consists of a modifier of the form
631 \(lq\fB~\fP\fIcharacter\fP\(rq, possibly followed by a parameter
632 against which mutt is supposed to match the object specified by
633 this modifier. For some \fIcharacter\fPs, the \fB~\fP may be
634 replaced by another character to alter the behavior of the match.
635 These are described in the list of modifiers, below.
636 .PP
637 With some of these modifiers, the object to be matched consists of
638 several e-mail addresses. In these cases, the object is matched if
639 at least one of these e-mail addresses matches. You can prepend a
640 hat (\(lq\fB^\fP\(rq) character to such a pattern to indicate that
641 \fIall\fP addresses must match in order to match the object.
642 .PP
643 You can construct complex patterns by combining simple patterns with
644 logical operators. Logical AND is specified by simply concatenating
645 two simple patterns, for instance \(lq~C mutt-dev ~s bug\(rq.
646 Logical OR is specified by inserting a vertical bar (\(lq\fB|\fP\(rq)
647 between two patterns, for instance \(lq~C mutt-dev | ~s bug\(rq.
648 Additionally, you can negate a pattern by prepending a bang
649 (\(lq\fB!\fP\(rq) character. For logical grouping, use braces
650 (\(lq()\(rq). Example: \(lq!(~t mutt|~c mutt) ~f elkins\(rq.
651 .SS Simple Patterns
652 .PP
653 Mutt understands the following simple patterns:
654 .P
655 .PD 0
656 .TP 12
657 ~A
658 all messages
659 .TP
660 ~b \fIEXPR\fP
661 messages which contain \fIEXPR\fP in the message body.
662 .TP
663 =b \fISTRING\fP
664 If IMAP is enabled, like ~b but searches for \fISTRING\fP on the server, rather than downloading each message and searching it locally.
665 .TP
666 ~B \fIEXPR\fP
667 messages which contain \fIEXPR\fP in the whole message.
668 .TP
669 =B \fISTRING\fP
670 If IMAP is enabled, like ~B but searches for \fISTRING\fP on the server, rather than downloading each message and searching it locally.
671 .TP
672 ~c \fIEXPR\fP
673 messages carbon-copied to \fIEXPR\fP
674 .TP
675 %c \fIGROUP\fP
676 messages carbon-copied to any member of \fIGROUP\fP
677 .TP
678 ~C \fIEXPR\fP
679 messages either to: or cc: \fIEXPR\fP
680 .TP
681 %C \fIGROUP\fP
682 messages either to: or cc: to any member of \fIGROUP\fP
683 .TP
684 ~d \fIMIN\fP-\fIMAX\fP
685 messages with \(lqdate-sent\(rq in a Date range
686 .TP
687 ~D
688 deleted messages
689 .TP
690 ~e \fIEXPR\fP
691 messages which contain \fIEXPR\fP in the \(lqSender\(rq field
692 .TP
693 %e \fIGROUP\fP
694 messages which contain a member of \fIGROUP\fP in the \(lqSender\(rq field
695 .TP
696 ~E
697 expired messages
698 .TP
699 ~f \fIEXPR\fP
700 messages originating from \fIEXPR\fP
701 .TP
702 %f \fIGROUP\fP
703 messages originating from any member of \fIGROUP\fP
704 .TP
705 ~F
706 flagged messages
707 .TP
708 ~g
709 PGP signed messages
710 .TP
711 ~G
712 PGP encrypted messages
713 .TP
714 ~h \fIEXPR\fP
715 messages which contain \fIEXPR\fP in the message header
716 .TP
717 =h \fISTRING\fP
718 If IMAP is enabled, like ~h but searches for \fISTRING\fP on the server, rather than downloading each message and searching it locally. \fISTRING\fP must be of the form \(lqheader: substring\(rq
719 .TP
720 ~H \fIEXPR\fP
721 messages with spam tags matching \fIEXPR\fP
722 .TP
723 ~i \fIEXPR\fP
724 messages which match \fIEXPR\fP in the \(lqMessage-ID\(rq field
725 .TP
726 ~k
727 messages containing PGP key material
728 .TP
729 ~l
730 messages addressed to a known mailing list (defined by either \fBsubscribe\fP or \fBlist\fP)
731 .TP
732 ~L \fIEXPR\fP
733 messages either originated or received by \fIEXPR\fP
734 .TP
735 %L \fIGROUP\fP
736 messages either originated or received by any member of \fIGROUP\fP
737 .TP
738 ~m \fIMIN\fP-\fIMAX\fP
739 message in the range \fIMIN\fP to \fIMAX\fP
740 .TP
741 ~M \fIEXPR\fP
742 messages which contain a mime Content-Type matching \fIEXPR\fP
743 .TP
744 ~n \fIMIN\fP-\fIMAX\fP
745 messages with a score in the range \fIMIN\fP to \fIMAX\fP
746 .TP
747 ~N
748 new messages
749 .TP
750 ~O
751 old messages
752 .TP
753 ~p
754 messages addressed to you (consults $from, \fBalternates\fP, and local account/hostname information)
755 .TP
756 ~P
757 messages from you (consults $from, \fBalternates\fP, and local account/hostname information)
758 .TP
759 ~Q
760 messages which have been replied to
761 .TP
762 ~r \fIMIN\fP-\fIMAX\fP
763 messages with \(lqdate-received\(rq in a Date range
764 .TP
765 ~R
766 read messages
767 .TP
768 ~s \fIEXPR\fP
769 messages having \fIEXPR\fP in the \(lqSubject\(rq field.
770 .TP
771 ~S
772 superseded messages
773 .TP
774 ~t \fIEXPR\fP
775 messages addressed to \fIEXPR\fP
776 .TP
777 ~T
778 tagged messages
779 .TP
780 ~u
781 messages addressed to a subscribed mailing list (defined by \fBsubscribe\fP commands)
782 .TP
783 ~U
784 unread messages
785 .TP
786 ~v
787 message is part of a collapsed thread.
788 .TP
789 ~V
790 cryptographically verified messages
791 .TP
792 ~x \fIEXPR\fP
793 messages which contain \fIEXPR\fP in the \(lqReferences\(rq or \(lqIn-Reply-To\(rq field
794 .TP
795 ~X \fIMIN\fP-\fIMAX\fP
796 messages with MIN - MAX attachments
797 .TP
798 ~y \fIEXPR\fP
799 messages which contain \fIEXPR\fP in the \(lqX-Label\(rq field
800 .TP
801 ~z \fIMIN\fP-\fIMAX\fP
802 messages with a size in the range \fIMIN\fP to \fIMAX\fP
803 .TP
804 ~=
805 duplicated messages (see $duplicate_threads)
806 .TP
807 ~$
808 unreferenced message (requires threaded view)
809 .TP
810 ~(PATTERN)
811 messages in threads containing messages matching a certain pattern, e.g. all threads containing messages from you: ~(~P)
812 .TP
813 ~<(PATTERN)
814 messages whose immediate parent matches PATTERN, e.g. replies to your messages: ~<(~P)
815 .TP
816 ~>(PATTERN)
817 messages having an immediate child matching PATTERN, e.g. messages you replied to: ~>(~P)
818 .PD 1
819 .DT
820 .PP
821 In the above, \fIEXPR\fP is a regular expression.
822 .PP
823 With the \fB~d\fP, \fB~m\fP, \fB~n\fP, \fB~r\fP, \fB~X\fP, and \fB~z\fP modifiers, you can also
824 specify ranges in the forms \fB<\fP\fIMAX\fP, \fB>\fP\fIMIN\fP,
825 \fIMIN\fP\fB-\fP, and \fB-\fP\fIMAX\fP.
826 .PP
827 With the \fB~z\fP modifier, the suffixes \(lqK\(rq and \(lqM\(rq are allowed to specify
828 kilobyte and megabyte respectively.
829 .PP
830 The \fB~b\fP, \fB~B\fP, \fB~h\fP, \fB~M\fP, and \fB~X\fP modifiers
831 require reading each message in, which can be much slower.
832 .PP
833 You can force Mutt to treat \fIEXPR\fP as a simple string instead of a
834 regular expression by using = instead of ~ in the pattern name.
835 .SS Matching dates
836 .PP
837 The \fB~d\fP and \fB~r\fP modifiers are used to match date ranges,
838 which are interpreted to be given in your local time zone.
839 .PP
840 A date is of the form
841 \fIDD\fP[\fB/\fP\fIMM\fP[\fB/\fP[\fIcc\fP]\fIYY\fP]], that is, a
842 two-digit date, optionally followed by a two-digit month, optionally
843 followed by a year specifications. Omitted fields default to the
844 current month and year.
845 .PP
846 Mutt understands either two or four digit year specifications. When
847 given a two-digit year, mutt will interpret values less than 70 as
848 lying in the 21st century (i.e., \(lq38\(rq means 2038 and not 1938,
849 and \(lq00\(rq is interpreted as 2000), and values
850 greater than or equal to 70 as lying in the 20th century.
851 .PP
852 Note that this behavior \fIis\fP Y2K compliant, but that mutt
853 \fIdoes\fP have a Y2.07K problem.
854 .PP
855 Alternatively, you may use \fIYYYYMMDD\fP to specify a date.
856 .PP
857 If a date range consists of a single date, the modifier in question
858 will match that precise date. If the date range consists of a dash
859 (\(lq\fB-\fP\(rq), followed by a date, this range will match any
860 date before and up to the date given. Similarly, a date followed by
861 a dash matches the date given and any later point of time. Two
862 dates, separated by a dash, match any date which lies in the given
863 range of time.
864 .PP
865 You can also modify any absolute date by giving an error range. An
866 error range consists of one of the characters
867 .BR + ,
868 .BR - ,
869 .BR * ,
870 followed by a positive number, followed by one of the unit
871 characters
872 .BR y ,
873 .BR m ,
874 .BR w ", or"
875 .BR d ,
876 specifying a unit of years, months, weeks, or days.
877 .B +
878 increases the maximum date matched by the given interval of time,
879 .B -
880 decreases the minimum date matched by the given interval of time, and
881 .B *
882 increases the maximum date and decreases the minimum date matched by
883 the given interval of time. It is possible to give multiple error
884 margins, which cumulate. Example:
885 .B "1/1/2001-1w+2w*3d"
886 .PP
887 You can also specify offsets relative to the current date. An
888 offset is specified as one of the characters
889 .BR < ,
890 .BR > ,
891 .BR = ,
892 followed by a positive number, followed by one of the unit
893 characters
894 .BR y ,
895 .BR m ,
896 .BR w ,
897 .BR d ,
898 .BR H ,
899 .BR M ", or"
900 .BR S .
901 .B >
902 matches dates which are older than the specified amount of time, an
903 offset which begins with the character
904 .B <
905 matches dates which are more recent than the specified amount of time,
906 and an offset which begins with the character
907 .B =
908 matches points of time which are precisely the given amount of time
909 ago.
910 .SH CONFIGURATION VARIABLES
911
912 .TP
913 .B abort_noattach
914 .nf
915 Type: quadoption
916 Default: no
917 .fi
918 .IP
919 When the body of the message matches $abort_noattach_regexp and
920 there are no attachments, this quadoption controls whether to
921 abort sending the message.
922
923
924 .TP
925 .B abort_noattach_regexp
926 .nf
927 Type: regular expression
928 Default: \(lqattach\(rq
929 .fi
930 .IP
931 Specifies a regular expression to match against the body of the
932 message, to determine if an attachment was mentioned but
933 mistakenly forgotten. If it matches, $abort_noattach will be
934 consulted to determine if message sending will be aborted.
935 .IP
936 Like other regular expressions in Mutt, the search is case
937 sensitive if the pattern contains at least one upper case letter,
938 and case insensitive otherwise.
939
940
941 .TP
942 .B abort_nosubject
943 .nf
944 Type: quadoption
945 Default: ask\-yes
946 .fi
947 .IP
948 If set to \fIyes\fP, when composing messages and no subject is given
949 at the subject prompt, composition will be aborted. If set to
950 \fIno\fP, composing messages with no subject given at the subject
951 prompt will never be aborted.
952
953
954 .TP
955 .B abort_unmodified
956 .nf
957 Type: quadoption
958 Default: yes
959 .fi
960 .IP
961 If set to \fIyes\fP, composition will automatically abort after
962 editing the message body if no changes are made to the file (this
963 check only happens after the \fIfirst\fP edit of the file). When set
964 to \fIno\fP, composition will never be aborted.
965
966
967 .TP
968 .B alias_file
969 .nf
970 Type: path
971 Default: \(lq~/.muttrc\(rq
972 .fi
973 .IP
974 The default file in which to save aliases created by the
975 \fB<create-alias>\fP function. Entries added to this file are
976 encoded in the character set specified by $config_charset if it
977 is \fIset\fP or the current character set otherwise.
978 .IP
979 \fBNote:\fP Mutt will not automatically source this file; you must
980 explicitly use the \(lqsource\(rq command for it to be executed in case
981 this option points to a dedicated alias file.
982 .IP
983 The default for this option is the currently used muttrc file, or
984 \(lq~/.muttrc\(rq if no user muttrc was found.
985
986
987 .TP
988 .B alias_format
989 .nf
990 Type: string
991 Default: \(lq%4n %2f %t %\-10a %r\(rq
992 .fi
993 .IP
994 Specifies the format of the data displayed for the \(lqalias\(rq menu. The
995 following \fBprintf(3)\fP\-style sequences are available:
996 .RS
997 .PD 0
998 .TP
999 %a
1000 alias name
1001 .TP
1002 %f
1003 flags \- currently, a \(lqd\(rq for an alias marked for deletion
1004 .TP
1005 %n
1006 index number
1007 .TP
1008 %r
1009 address which alias expands to
1010 .TP
1011 %t
1012 character which indicates if the alias is tagged for inclusion
1013 .RE
1014 .PD 1
1015
1016 .TP
1017 .B allow_8bit
1018 .nf
1019 Type: boolean
1020 Default: yes
1021 .fi
1022 .IP
1023 Controls whether 8\-bit data is converted to 7\-bit using either Quoted\-
1024 Printable or Base64 encoding when sending mail.
1025
1026
1027 .TP
1028 .B allow_ansi
1029 .nf
1030 Type: boolean
1031 Default: no
1032 .fi
1033 .IP
1034 Controls whether ANSI color codes in messages (and color tags in
1035 rich text messages) are to be interpreted.
1036 Messages containing these codes are rare, but if this option is \fIset\fP,
1037 their text will be colored accordingly. Note that this may override
1038 your color choices, and even present a security problem, since a
1039 message could include a line like
1040
1041 .IP
1042 .EX
1043 [\-\- PGP output follows ...
1044
1045 .EE
1046 .IP
1047 and give it the same color as your attachment color (see also
1048 $crypt_timestamp).
1049
1050
1051 .TP
1052 .B arrow_cursor
1053 .nf
1054 Type: boolean
1055 Default: no
1056 .fi
1057 .IP
1058 When \fIset\fP, an arrow (\(lq\->\(rq) will be used to indicate the current entry
1059 in menus instead of highlighting the whole line. On slow network or modem
1060 links this will make response faster because there is less that has to
1061 be redrawn on the screen when moving to the next or previous entries
1062 in the menu.
1063
1064
1065 .TP
1066 .B ascii_chars
1067 .nf
1068 Type: boolean
1069 Default: no
1070 .fi
1071 .IP
1072 If \fIset\fP, Mutt will use plain ASCII characters when displaying thread
1073 and attachment trees, instead of the default \fIACS\fP characters.
1074
1075
1076 .TP
1077 .B askbcc
1078 .nf
1079 Type: boolean
1080 Default: no
1081 .fi
1082 .IP
1083 If \fIset\fP, Mutt will prompt you for blind\-carbon\-copy (Bcc) recipients
1084 before editing an outgoing message.
1085
1086
1087 .TP
1088 .B askcc
1089 .nf
1090 Type: boolean
1091 Default: no
1092 .fi
1093 .IP
1094 If \fIset\fP, Mutt will prompt you for carbon\-copy (Cc) recipients before
1095 editing the body of an outgoing message.
1096
1097
1098 .TP
1099 .B assumed_charset
1100 .nf
1101 Type: string
1102 Default: \(lq\(rq
1103 .fi
1104 .IP
1105 This variable is a colon\-separated list of character encoding
1106 schemes for messages without character encoding indication.
1107 Header field values and message body content without character encoding
1108 indication would be assumed that they are written in one of this list.
1109 By default, all the header fields and message body without any charset
1110 indication are assumed to be in \(lqus\-ascii\(rq.
1111 .IP
1112 For example, Japanese users might prefer this:
1113
1114 .IP
1115 .EX
1116 set assumed_charset=\(rqiso\-2022\-jp:euc\-jp:shift_jis:utf\-8\(rq
1117
1118 .EE
1119 .IP
1120 However, only the first content is valid for the message body.
1121
1122
1123 .TP
1124 .B attach_charset
1125 .nf
1126 Type: string
1127 Default: \(lq\(rq
1128 .fi
1129 .IP
1130 This variable is a colon\-separated list of character encoding
1131 schemes for text file attachments. Mutt uses this setting to guess
1132 which encoding files being attached are encoded in to convert them to
1133 a proper character set given in $send_charset.
1134 .IP
1135 If \fIunset\fP, the value of $charset will be used instead.
1136 For example, the following configuration would work for Japanese
1137 text handling:
1138
1139 .IP
1140 .EX
1141 set attach_charset=\(rqiso\-2022\-jp:euc\-jp:shift_jis:utf\-8\(rq
1142
1143 .EE
1144 .IP
1145 Note: for Japanese users, \(lqiso\-2022\-*\(rq must be put at the head
1146 of the value as shown above if included.
1147
1148
1149 .TP
1150 .B attach_format
1151 .nf
1152 Type: string
1153 Default: \(lq%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] \(rq
1154 .fi
1155 .IP
1156 This variable describes the format of the \(lqattachment\(rq menu. The
1157 following \fBprintf(3)\fP\-style sequences are understood:
1158 .RS
1159 .PD 0
1160 .TP
1161 %C
1162 charset
1163 .TP
1164 %c
1165 requires charset conversion (\(lqn\(rq or \(lqc\(rq)
1166 .TP
1167 %D
1168 deleted flag
1169 .TP
1170 %d
1171 description (if none, falls back to %F)
1172 .TP
1173 %e
1174 MIME content\-transfer\-encoding
1175 .TP
1176 %F
1177 filename in content\-disposition header (if none, falls back to %f)
1178 .TP
1179 %f
1180 filename
1181 .TP
1182 %I
1183 disposition (\(lqI\(rq for inline, \(lqA\(rq for attachment)
1184 .TP
1185 %m
1186 major MIME type
1187 .TP
1188 %M
1189 MIME subtype
1190 .TP
1191 %n
1192 attachment number
1193 .TP
1194 %Q
1195 \(lqQ\(rq, if MIME part qualifies for attachment counting
1196 .TP
1197 %s
1198 size (see formatstrings-size)
1199 .TP
1200 %t
1201 tagged flag
1202 .TP
1203 %T
1204 graphic tree characters
1205 .TP
1206 %u
1207 unlink (=to delete) flag
1208 .TP
1209 %X
1210 number of qualifying MIME parts in this part and its children
1211 (please see the \(lqattachments\(rq section for possible speed effects)
1212 .TP
1213 %>X
1214 right justify the rest of the string and pad with character \(lqX\(rq
1215 .TP
1216 %|X
1217 pad to the end of the line with character \(lqX\(rq
1218 .TP
1219 %*X
1220 soft\-fill with character \(lqX\(rq as pad
1221 .RE
1222 .PD 1
1223 .IP
1224 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
1225
1226
1227 .TP
1228 .B attach_save_charset_convert
1229 .nf
1230 Type: quadoption
1231 Default: ask\-yes
1232 .fi
1233 .IP
1234 When saving received text\-type attachments, this quadoption
1235 prompts to convert the character set if the encoding of the
1236 attachment (or $assumed_charset if none is specified) differs
1237 from charset.
1238
1239
1240 .TP
1241 .B attach_save_dir
1242 .nf
1243 Type: path
1244 Default: \(lq\(rq
1245 .fi
1246 .IP
1247 The default directory to save attachments from the \(lqattachment\(rq menu.
1248 If it doesn't exist, Mutt will prompt to create the directory before
1249 saving.
1250 .IP
1251 If the path is invalid (e.g. not a directory, or cannot be
1252 chdir'ed to), Mutt will fall back to using the current directory.
1253
1254
1255 .TP
1256 .B attach_sep
1257 .nf
1258 Type: string
1259 Default: \(lq\\n\(rq
1260 .fi
1261 .IP
1262 The separator to add between attachments when operating (saving,
1263 printing, piping, etc) on a list of tagged attachments.
1264
1265
1266 .TP
1267 .B attach_split
1268 .nf
1269 Type: boolean
1270 Default: yes
1271 .fi
1272 .IP
1273 If this variable is \fIunset\fP, when operating (saving, printing, piping,
1274 etc) on a list of tagged attachments, Mutt will concatenate the
1275 attachments and will operate on them as a single attachment. The
1276 $attach_sep separator is added after each attachment. When \fIset\fP,
1277 Mutt will operate on the attachments one by one.
1278
1279
1280 .TP
1281 .B attribution
1282 .nf
1283 Type: string (localized)
1284 Default: \(lqOn %d, %n wrote:\(rq
1285 .fi
1286 .IP
1287 This is the string that will precede a message which has been included
1288 in a reply. For a full listing of defined \fBprintf(3)\fP\-like sequences see
1289 the section on $index_format.
1290
1291
1292 .TP
1293 .B attribution_locale
1294 .nf
1295 Type: string
1296 Default: \(lq\(rq
1297 .fi
1298 .IP
1299 The locale used by \fBstrftime(3)\fP to format dates in the
1300 attribution string. Legal values are the strings your system
1301 accepts for the locale environment variable \fB$LC_TIME\fP.
1302 .IP
1303 This variable is to allow the attribution date format to be
1304 customized by recipient or folder using hooks. By default, Mutt
1305 will use your locale environment, so there is no need to set
1306 this except to override that default.
1307
1308
1309 .TP
1310 .B auto_subscribe
1311 .nf
1312 Type: boolean
1313 Default: no
1314 .fi
1315 .IP
1316 When \fIset\fP, Mutt assumes the presence of a List\-Post header
1317 means the recipient is subscribed to the list. Unless the mailing list
1318 is in the \(lqunsubscribe\(rq or \(lqunlist\(rq lists, it will be added
1319 to the \(lqsubscribe\(rq list. Parsing and checking these things slows
1320 header reading down, so this option is disabled by default.
1321
1322
1323 .TP
1324 .B auto_tag
1325 .nf
1326 Type: boolean
1327 Default: no
1328 .fi
1329 .IP
1330 When \fIset\fP, functions in the \fIindex\fP menu which affect a message
1331 will be applied to all tagged messages (if there are any). When
1332 unset, you must first use the \fB<tag\-prefix>\fP function (bound to \(lq;\(rq
1333 by default) to make the next function apply to all tagged messages.
1334
1335
1336 .TP
1337 .B autocrypt
1338 .nf
1339 Type: boolean
1340 Default: no
1341 .fi
1342 .IP
1343 When \fIset\fP, enables autocrypt, which provides
1344 passive encryption protection with keys exchanged via headers.
1345 See \(lqautocryptdoc\(rq for more details.
1346 (Autocrypt only)
1347
1348
1349 .TP
1350 .B autocrypt_acct_format
1351 .nf
1352 Type: string
1353 Default: \(lq%4n %\-30a %20p %10s\(rq
1354 .fi
1355 .IP
1356 This variable describes the format of the \(lqautocrypt account\(rq menu.
1357 The following \fBprintf(3)\fP\-style sequences are understood
1358 .RS
1359 .PD 0
1360 .TP
1361 %a
1362 email address
1363 .TP
1364 %k
1365 gpg keyid
1366 .TP
1367 %n
1368 current entry number
1369 .TP
1370 %p
1371 prefer\-encrypt flag
1372 .TP
1373 %s
1374 status flag (active/inactive)
1375 .RE
1376 .PD 1
1377 .IP
1378 (Autocrypt only)
1379
1380
1381 .TP
1382 .B autocrypt_dir
1383 .nf
1384 Type: path
1385 Default: \(lq~/.mutt/autocrypt\(rq
1386 .fi
1387 .IP
1388 This variable sets where autocrypt files are stored, including the GPG
1389 keyring and sqlite database. See \(lqautocryptdoc\(rq for more details.
1390 (Autocrypt only)
1391
1392
1393 .TP
1394 .B autocrypt_reply
1395 .nf
1396 Type: boolean
1397 Default: yes
1398 .fi
1399 .IP
1400 When \fIset\fP, replying to an autocrypt email automatically
1401 enables autocrypt in the reply. You may want to unset this if you're using
1402 the same key for autocrypt as normal web\-of\-trust, so that autocrypt
1403 isn't forced on for all encrypted replies.
1404 (Autocrypt only)
1405
1406
1407 .TP
1408 .B autoedit
1409 .nf
1410 Type: boolean
1411 Default: no
1412 .fi
1413 .IP
1414 When \fIset\fP along with $edit_headers, Mutt will skip the initial
1415 send\-menu (prompting for subject and recipients) and allow you to
1416 immediately begin editing the body of your
1417 message. The send\-menu may still be accessed once you have finished
1418 editing the body of your message.
1419 .IP
1420 \fBNote:\fP when this option is \fIset\fP, you cannot use send\-hooks that depend
1421 on the recipients when composing a new (non\-reply) message, as the initial
1422 list of recipients is empty.
1423 .IP
1424 Also see $fast_reply.
1425
1426
1427 .TP
1428 .B background_edit
1429 .nf
1430 Type: boolean
1431 Default: no
1432 .fi
1433 .IP
1434 When \fIset\fP, Mutt will run $editor in the background during
1435 message composition. A landing page will display, waiting for
1436 the $editor to exit. The landing page may be exited, allowing
1437 perusal of the mailbox, or even for other messages to be
1438 composed. Backgrounded sessions may be returned to via the
1439 \fB<background\-compose\-menu>\fP function.
1440 .IP
1441 For background editing to work properly, $editor must be set to
1442 an editor that does not try to use the Mutt terminal: for example
1443 a graphical editor, or a script launching (and waiting for) the
1444 editor in another Gnu Screen window.
1445 .IP
1446 For more details, see \(lqbgedit\(rq (\(rqBackground Editing\(rq in the manual).
1447
1448
1449 .TP
1450 .B background_confirm_quit
1451 .nf
1452 Type: boolean
1453 Default: yes
1454 .fi
1455 .IP
1456 When \fIset\fP, if there are any background edit sessions, you
1457 will be prompted to confirm exiting Mutt, in addition to the
1458 $quit prompt.
1459
1460
1461 .TP
1462 .B background_format
1463 .nf
1464 Type: string
1465 Default: \(lq%10S %7p %s\(rq
1466 .fi
1467 .IP
1468 This variable describes the format of the \(lqbackground compose\(rq
1469 menu. The following \fBprintf(3)\fP\-style sequences are
1470 understood:
1471 .RS
1472 .PD 0
1473 .TP
1474 %i
1475 parent message id (for replies and forwarded messages)
1476 .TP
1477 %n
1478 the running number on the menu
1479 .TP
1480 %p
1481 pid of the $editor process
1482 .TP
1483 %r
1484 comma separated list of \(lqTo:\(rq recipients
1485 .TP
1486 %R
1487 comma separated list of \(lqCc:\(rq recipients
1488 .TP
1489 %s
1490 subject of the message
1491 .TP
1492 %S
1493 status of the $editor process: running/finished
1494 .RE
1495 .PD 1
1496
1497 .TP
1498 .B beep
1499 .nf
1500 Type: boolean
1501 Default: yes
1502 .fi
1503 .IP
1504 When this variable is \fIset\fP, mutt will beep when an error occurs.
1505
1506
1507 .TP
1508 .B beep_new
1509 .nf
1510 Type: boolean
1511 Default: no
1512 .fi
1513 .IP
1514 When this variable is \fIset\fP, mutt will beep whenever it prints a message
1515 notifying you of new mail. This is independent of the setting of the
1516 $beep variable.
1517
1518
1519 .TP
1520 .B bounce
1521 .nf
1522 Type: quadoption
1523 Default: ask\-yes
1524 .fi
1525 .IP
1526 Controls whether you will be asked to confirm bouncing messages.
1527 If set to \fIyes\fP you don't get asked if you want to bounce a
1528 message. Setting this variable to \fIno\fP is not generally useful,
1529 and thus not recommended, because you are unable to bounce messages.
1530
1531
1532 .TP
1533 .B bounce_delivered
1534 .nf
1535 Type: boolean
1536 Default: yes
1537 .fi
1538 .IP
1539 When this variable is \fIset\fP, mutt will include Delivered\-To headers when
1540 bouncing messages. Postfix users may wish to \fIunset\fP this variable.
1541
1542
1543 .TP
1544 .B braille_friendly
1545 .nf
1546 Type: boolean
1547 Default: no
1548 .fi
1549 .IP
1550 When this variable is \fIset\fP, mutt will place the cursor at the beginning
1551 of the current line in menus, even when the $arrow_cursor variable
1552 is \fIunset\fP, making it easier for blind persons using Braille displays to
1553 follow these menus. The option is \fIunset\fP by default because many
1554 visual terminals don't permit making the cursor invisible.
1555
1556
1557 .TP
1558 .B browser_abbreviate_mailboxes
1559 .nf
1560 Type: boolean
1561 Default: yes
1562 .fi
1563 .IP
1564 When this variable is \fIset\fP, mutt will abbreviate mailbox
1565 names in the browser mailbox list, using '~' and '='
1566 shortcuts.
1567 .IP
1568 The default \fB\(rqalpha\(rq\fP setting of $sort_browser uses
1569 locale\-based sorting (using \fBstrcoll(3)\fP), which ignores some
1570 punctuation. This can lead to some situations where the order
1571 doesn't make intuitive sense. In those cases, it may be
1572 desirable to \fIunset\fP this variable.
1573
1574
1575 .TP
1576 .B browser_sticky_cursor
1577 .nf
1578 Type: boolean
1579 Default: yes
1580 .fi
1581 .IP
1582 When this variable is \fIset\fP, the browser will attempt to keep
1583 the cursor on the same mailbox when performing various functions.
1584 These include moving up a directory, toggling between mailboxes
1585 and directory listing, creating/renaming a mailbox, toggling
1586 subscribed mailboxes, and entering a new mask.
1587
1588
1589 .TP
1590 .B certificate_file
1591 .nf
1592 Type: path
1593 Default: \(lq~/.mutt_certificates\(rq
1594 .fi
1595 .IP
1596 This variable specifies the file where the certificates you trust
1597 are saved. When an unknown certificate is encountered, you are asked
1598 if you accept it or not. If you accept it, the certificate can also
1599 be saved in this file and further connections are automatically
1600 accepted.
1601 .IP
1602 You can also manually add CA certificates in this file. Any server
1603 certificate that is signed with one of these CA certificates is
1604 also automatically accepted.
1605 .IP
1606 Example:
1607
1608 .IP
1609 .EX
1610 set certificate_file=~/.mutt/certificates
1611
1612 .EE
1613 .IP
1614 (OpenSSL and GnuTLS only)
1615
1616
1617 .TP
1618 .B change_folder_next
1619 .nf
1620 Type: boolean
1621 Default: no
1622 .fi
1623 .IP
1624 When this variable is \fIset\fP, the \fB<change\-folder>\fP function
1625 mailbox suggestion will start at the next folder in your \(lqmailboxes\(rq
1626 list, instead of starting at the first folder in the list.
1627
1628
1629 .TP
1630 .B charset
1631 .nf
1632 Type: string
1633 Default: \(lq\(rq
1634 .fi
1635 .IP
1636 Character set your terminal uses to display and enter textual data.
1637 It is also the fallback for $send_charset.
1638 .IP
1639 Upon startup Mutt tries to derive this value from environment variables
1640 such as \fB$LC_CTYPE\fP or \fB$LANG\fP.
1641 .IP
1642 \fBNote:\fP It should only be set in case Mutt isn't able to determine the
1643 character set used correctly.
1644
1645
1646 .TP
1647 .B check_mbox_size
1648 .nf
1649 Type: boolean
1650 Default: no
1651 .fi
1652 .IP
1653 When this variable is \fIset\fP, mutt will use file size attribute instead of
1654 access time when checking for new mail in mbox and mmdf folders.
1655 .IP
1656 This variable is \fIunset\fP by default and should only be enabled when
1657 new mail detection for these folder types is unreliable or doesn't work.
1658 .IP
1659 Note that enabling this variable should happen before any \(lqmailboxes\(rq
1660 directives occur in configuration files regarding mbox or mmdf folders
1661 because mutt needs to determine the initial new mail status of such a
1662 mailbox by performing a fast mailbox scan when it is defined.
1663 Afterwards the new mail status is tracked by file size changes.
1664
1665
1666 .TP
1667 .B check_new
1668 .nf
1669 Type: boolean
1670 Default: yes
1671 .fi
1672 .IP
1673 \fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
1674 mailboxes.
1675 .IP
1676 When \fIset\fP, Mutt will check for new mail delivered while the
1677 mailbox is open. Especially with MH mailboxes, this operation can
1678 take quite some time since it involves scanning the directory and
1679 checking each file to see if it has already been looked at. If
1680 this variable is \fIunset\fP, no check for new mail is performed
1681 while the mailbox is open.
1682
1683
1684 .TP
1685 .B collapse_unread
1686 .nf
1687 Type: boolean
1688 Default: yes
1689 .fi
1690 .IP
1691 When \fIunset\fP, Mutt will not collapse a thread if it contains any
1692 unread messages.
1693
1694
1695 .TP
1696 .B compose_confirm_detach_first
1697 .nf
1698 Type: boolean
1699 Default: yes
1700 .fi
1701 .IP
1702 When \fIset\fP, Mutt will prompt for confirmation when trying to
1703 use \fB<detach\-file>\fP on the first entry in the compose menu.
1704 This is to help prevent irreversible loss of the typed message by
1705 accidentally hitting 'D' in the menu.
1706 .IP
1707 Note: Mutt only prompts for the first entry. It doesn't keep
1708 track of which message is the typed message if the entries are
1709 reordered, or if the first entry was already deleted.
1710
1711
1712 .TP
1713 .B compose_format
1714 .nf
1715 Type: string (localized)
1716 Default: \(lq\-\- Mutt: Compose [Approx. msg size: %l Atts: %a]%>\-\(rq
1717 .fi
1718 .IP
1719 Controls the format of the status line displayed in the \(lqcompose\(rq
1720 menu. This string is similar to $status_format, but has its own
1721 set of \fBprintf(3)\fP\-like sequences:
1722 .RS
1723 .PD 0
1724 .TP
1725 %a
1726 total number of attachments
1727 .TP
1728 %h
1729 local hostname
1730 .TP
1731 %l
1732 approximate size (in bytes) of the current message (see formatstrings-size)
1733 .TP
1734 %v
1735 Mutt version string
1736 .RE
1737 .PD 1
1738 .IP
1739 See the text describing the $status_format option for more
1740 information on how to set $compose_format.
1741
1742
1743 .TP
1744 .B config_charset
1745 .nf
1746 Type: string
1747 Default: \(lq\(rq
1748 .fi
1749 .IP
1750 When defined, Mutt will recode commands in rc files from this
1751 encoding to the current character set as specified by $charset
1752 and aliases written to $alias_file from the current character set.
1753 .IP
1754 Please note that if setting $charset it must be done before
1755 setting $config_charset.
1756 .IP
1757 Recoding should be avoided as it may render unconvertable
1758 characters as question marks which can lead to undesired
1759 side effects (for example in regular expressions).
1760
1761
1762 .TP
1763 .B confirmappend
1764 .nf
1765 Type: boolean
1766 Default: yes
1767 .fi
1768 .IP
1769 When \fIset\fP, Mutt will prompt for confirmation when appending messages to
1770 an existing mailbox.
1771
1772
1773 .TP
1774 .B confirmcreate
1775 .nf
1776 Type: boolean
1777 Default: yes
1778 .fi
1779 .IP
1780 When \fIset\fP, Mutt will prompt for confirmation when saving messages to a
1781 mailbox which does not yet exist before creating it.
1782
1783
1784 .TP
1785 .B connect_timeout
1786 .nf
1787 Type: number
1788 Default: 30
1789 .fi
1790 .IP
1791 Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
1792 many seconds if the connection is not able to be established. A negative
1793 value causes Mutt to wait indefinitely for the connection attempt to succeed.
1794
1795
1796 .TP
1797 .B content_type
1798 .nf
1799 Type: string
1800 Default: \(lqtext/plain\(rq
1801 .fi
1802 .IP
1803 Sets the default Content\-Type for the body of newly composed messages.
1804
1805
1806 .TP
1807 .B copy
1808 .nf
1809 Type: quadoption
1810 Default: yes
1811 .fi
1812 .IP
1813 This variable controls whether or not copies of your outgoing messages
1814 will be saved for later references. Also see $record,
1815 $save_name, $force_name and \(lqfcc-hook\(rq.
1816
1817
1818 .TP
1819 .B copy_decode_weed
1820 .nf
1821 Type: boolean
1822 Default: no
1823 .fi
1824 .IP
1825 Controls whether Mutt will weed headers when invoking the
1826 \fB<decode\-copy>\fP or \fB<decode\-save>\fP functions.
1827
1828
1829 .TP
1830 .B count_alternatives
1831 .nf
1832 Type: boolean
1833 Default: no
1834 .fi
1835 .IP
1836 When \fIset\fP, Mutt will recurse inside multipart/alternatives while
1837 performing attachment searching and counting (see attachments).
1838 .IP
1839 Traditionally, multipart/alternative parts have simply represented
1840 different encodings of the main content of the email. Unfortunately,
1841 some mail clients have started to place email attachments inside
1842 one of alternatives. Setting this will allow Mutt to find
1843 and count matching attachments hidden there, and include them
1844 in the index via %X or through ~X pattern matching.
1845
1846
1847 .TP
1848 .B cursor_overlay
1849 .nf
1850 Type: boolean
1851 Default: no
1852 .fi
1853 .IP
1854 When \fIset\fP, Mutt will overlay the indicator, tree,
1855 sidebar_highlight, and sidebar_indicator colors onto the currently
1856 selected line. This will allow \fBdefault\fP colors in those
1857 to be overridden, and for attributes to be merged between
1858 the layers.
1859
1860
1861 .TP
1862 .B crypt_autoencrypt
1863 .nf
1864 Type: boolean
1865 Default: no
1866 .fi
1867 .IP
1868 Setting this variable will cause Mutt to always attempt to PGP
1869 encrypt outgoing messages. This is probably only useful in
1870 connection to the \(lqsend-hook\(rq command. It can be overridden
1871 by use of the pgp menu, when encryption is not required or
1872 signing is requested as well. If $smime_is_default is \fIset\fP,
1873 then OpenSSL is used instead to create S/MIME messages and
1874 settings can be overridden by use of the smime menu instead.
1875 (Crypto only)
1876
1877
1878 .TP
1879 .B crypt_autopgp
1880 .nf
1881 Type: boolean
1882 Default: yes
1883 .fi
1884 .IP
1885 This variable controls whether or not mutt may automatically enable
1886 PGP encryption/signing for messages. See also $crypt_autoencrypt,
1887 $crypt_replyencrypt,
1888 $crypt_autosign, $crypt_replysign and $smime_is_default.
1889
1890
1891 .TP
1892 .B crypt_autosign
1893 .nf
1894 Type: boolean
1895 Default: no
1896 .fi
1897 .IP
1898 Setting this variable will cause Mutt to always attempt to
1899 cryptographically sign outgoing messages. This can be overridden
1900 by use of the pgp menu, when signing is not required or
1901 encryption is requested as well. If $smime_is_default is \fIset\fP,
1902 then OpenSSL is used instead to create S/MIME messages and settings can
1903 be overridden by use of the smime menu instead of the pgp menu.
1904 (Crypto only)
1905
1906
1907 .TP
1908 .B crypt_autosmime
1909 .nf
1910 Type: boolean
1911 Default: yes
1912 .fi
1913 .IP
1914 This variable controls whether or not mutt may automatically enable
1915 S/MIME encryption/signing for messages. See also $crypt_autoencrypt,
1916 $crypt_replyencrypt,
1917 $crypt_autosign, $crypt_replysign and $smime_is_default.
1918
1919
1920 .TP
1921 .B crypt_confirmhook
1922 .nf
1923 Type: boolean
1924 Default: yes
1925 .fi
1926 .IP
1927 If set, then you will be prompted for confirmation of keys when using
1928 the \fIcrypt\-hook\fP command. If unset, no such confirmation prompt will
1929 be presented. This is generally considered unsafe, especially where
1930 typos are concerned.
1931
1932
1933 .TP
1934 .B crypt_opportunistic_encrypt
1935 .nf
1936 Type: boolean
1937 Default: no
1938 .fi
1939 .IP
1940 Setting this variable will cause Mutt to automatically enable and
1941 disable encryption, based on whether all message recipient keys
1942 can be located by Mutt.
1943 .IP
1944 When this option is enabled, Mutt will enable/disable encryption
1945 each time the TO, CC, and BCC lists are edited. If
1946 $edit_headers is set, Mutt will also do so each time the message
1947 is edited.
1948 .IP
1949 While this is set, encryption can't be manually enabled/disabled.
1950 The pgp or smime menus provide a selection to temporarily disable
1951 this option for the current message.
1952 .IP
1953 If $crypt_autoencrypt or $crypt_replyencrypt enable encryption for
1954 a message, this option will be disabled for that message. It can
1955 be manually re\-enabled in the pgp or smime menus.
1956 (Crypto only)
1957
1958
1959 .TP
1960 .B crypt_opportunistic_encrypt_strong_keys
1961 .nf
1962 Type: boolean
1963 Default: no
1964 .fi
1965 .IP
1966 When set, this modifies the behavior of $crypt_opportunistic_encrypt
1967 to only search for \(rqstrong keys\(rq, that is, keys with full validity
1968 according to the web\-of\-trust algorithm. A key with marginal or no
1969 validity will not enable opportunistic encryption.
1970 .IP
1971 For S/MIME, the behavior depends on the backend. Classic S/MIME will
1972 filter for certificates with the 't' (trusted) flag in the .index file.
1973 The GPGME backend will use the same filters as with OpenPGP, and depends
1974 on GPGME's logic for assigning the GPGME_VALIDITY_FULL and
1975 GPGME_VALIDITY_ULTIMATE validity flag.
1976
1977
1978 .TP
1979 .B crypt_protected_headers_read
1980 .nf
1981 Type: boolean
1982 Default: yes
1983 .fi
1984 .IP
1985 When set, Mutt will display protected headers in the pager,
1986 and will update the index and header cache with revised headers.
1987 Protected headers are stored inside the encrypted or signed part of an
1988 an email, to prevent disclosure or tampering.
1989 For more information see https://github.com/autocrypt/protected\-headers.
1990 Currently Mutt only supports the Subject header.
1991 .IP
1992 Encrypted messages using protected headers often substitute the exposed
1993 Subject header with a dummy value (see $crypt_protected_headers_subject).
1994 Mutt will update its concept of the correct subject \fBafter\fP the
1995 message is opened, i.e. via the \fB<display\-message>\fP function.
1996 If you reply to a message before opening it, Mutt will end up using
1997 the dummy Subject header, so be sure to open such a message first.
1998 (Crypto only)
1999
2000
2001 .TP
2002 .B crypt_protected_headers_save
2003 .nf
2004 Type: boolean
2005 Default: no
2006 .fi
2007 .IP
2008 When $crypt_protected_headers_read is set, and a message with a
2009 protected Subject is opened, Mutt will save the updated Subject
2010 into the header cache by default. This allows searching/limiting
2011 based on the protected Subject header if the mailbox is
2012 re\-opened, without having to re\-open the message each time.
2013 However, for mbox/mh mailbox types, or if header caching is not
2014 set up, you would need to re\-open the message each time the
2015 mailbox was reopened before you could see or search/limit on the
2016 protected subject again.
2017 .IP
2018 When this variable is set, Mutt additionally saves the protected
2019 Subject back \fBin the clear\-text message headers\fP. This
2020 provides better usability, but with the tradeoff of reduced
2021 security. The protected Subject header, which may have
2022 previously been encrypted, is now stored in clear\-text in the
2023 message headers. Copying the message elsewhere, via Mutt or
2024 external tools, could expose this previously encrypted data.
2025 Please make sure you understand the consequences of this before
2026 you enable this variable.
2027 (Crypto only)
2028
2029
2030 .TP
2031 .B crypt_protected_headers_subject
2032 .nf
2033 Type: string
2034 Default: \(lq...\(rq
2035 .fi
2036 .IP
2037 When $crypt_protected_headers_write is set, and the message is marked
2038 for encryption, this will be substituted into the Subject field in the
2039 message headers.
2040 To prevent a subject from being substituted, unset this variable, or set it
2041 to the empty string.
2042 (Crypto only)
2043
2044
2045 .TP
2046 .B crypt_protected_headers_write
2047 .nf
2048 Type: boolean
2049 Default: no
2050 .fi
2051 .IP
2052 When set, Mutt will generate protected headers for signed and
2053 encrypted emails.
2054 Protected headers are stored inside the encrypted or signed part of an
2055 an email, to prevent disclosure or tampering.
2056 For more information see https://github.com/autocrypt/protected\-headers.
2057 Currently Mutt only supports the Subject header.
2058 (Crypto only)
2059
2060
2061 .TP
2062 .B crypt_replyencrypt
2063 .nf
2064 Type: boolean
2065 Default: yes
2066 .fi
2067 .IP
2068 If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are
2069 encrypted.
2070 (Crypto only)
2071
2072
2073 .TP
2074 .B crypt_replysign
2075 .nf
2076 Type: boolean
2077 Default: no
2078 .fi
2079 .IP
2080 If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are
2081 signed.
2082 .IP
2083 \fBNote:\fP this does not work on messages that are encrypted
2084 \fIand\fP signed!
2085 (Crypto only)
2086
2087
2088 .TP
2089 .B crypt_replysignencrypted
2090 .nf
2091 Type: boolean
2092 Default: no
2093 .fi
2094 .IP
2095 If \fIset\fP, automatically PGP or OpenSSL sign replies to messages
2096 which are encrypted. This makes sense in combination with
2097 $crypt_replyencrypt, because it allows you to sign all
2098 messages which are automatically encrypted. This works around
2099 the problem noted in $crypt_replysign, that mutt is not able
2100 to find out whether an encrypted message is also signed.
2101 (Crypto only)
2102
2103
2104 .TP
2105 .B crypt_timestamp
2106 .nf
2107 Type: boolean
2108 Default: yes
2109 .fi
2110 .IP
2111 If \fIset\fP, mutt will include a time stamp in the lines surrounding
2112 PGP or S/MIME output, so spoofing such lines is more difficult.
2113 If you are using colors to mark these lines, and rely on these,
2114 you may \fIunset\fP this setting.
2115 (Crypto only)
2116
2117
2118 .TP
2119 .B crypt_use_gpgme
2120 .nf
2121 Type: boolean
2122 Default: no
2123 .fi
2124 .IP
2125 This variable controls the use of the GPGME\-enabled crypto backends.
2126 If it is \fIset\fP and Mutt was built with gpgme support, the gpgme code for
2127 S/MIME and PGP will be used instead of the classic code. Note that
2128 you need to set this option in .muttrc; it won't have any effect when
2129 used interactively.
2130 .IP
2131 Note that the GPGME backend does not support creating old\-style inline
2132 (traditional) PGP encrypted or signed messages (see $pgp_autoinline).
2133
2134
2135 .TP
2136 .B crypt_use_pka
2137 .nf
2138 Type: boolean
2139 Default: no
2140 .fi
2141 .IP
2142 Controls whether mutt uses PKA
2143 (see http://www.g10code.de/docs/pka\-intro.de.pdf) during signature
2144 verification (only supported by the GPGME backend).
2145
2146
2147 .TP
2148 .B crypt_verify_sig
2149 .nf
2150 Type: quadoption
2151 Default: yes
2152 .fi
2153 .IP
2154 If \fI\(lqyes\(rq\fP, always attempt to verify PGP or S/MIME signatures.
2155 If \fI\(lqask\-*\(rq\fP, ask whether or not to verify the signature.
2156 If \fI\(lqno\(rq\fP, never attempt to verify cryptographic signatures.
2157 (Crypto only)
2158
2159
2160 .TP
2161 .B date_format
2162 .nf
2163 Type: string
2164 Default: \(lq!%a, %b %d, %Y at %I:%M:%S%p %Z\(rq
2165 .fi
2166 .IP
2167 This variable controls the format of the date printed by the \(lq%d\(rq
2168 sequence in $index_format. This is passed to the \fBstrftime(3)\fP
2169 function to process the date, see the man page for the proper syntax.
2170 .IP
2171 Unless the first character in the string is a bang (\(lq!\(rq), the month
2172 and week day names are expanded according to the locale.
2173 If the first character in the string is a
2174 bang, the bang is discarded, and the month and week day names in the
2175 rest of the string are expanded in the \fIC\fP locale (that is in US
2176 English).
2177
2178
2179 .TP
2180 .B default_hook
2181 .nf
2182 Type: string
2183 Default: \(lq~f %s !~P | (~P ~C %s)\(rq
2184 .fi
2185 .IP
2186 This variable controls how \(lqmessage-hook\(rq, \(lqreply-hook\(rq, \(lqsend-hook\(rq,
2187 \(lqsend2-hook\(rq, \(lqsave-hook\(rq, and \(lqfcc-hook\(rq will
2188 be interpreted if they are specified with only a simple regexp,
2189 instead of a matching pattern. The hooks are expanded when they are
2190 declared, so a hook will be interpreted according to the value of this
2191 variable at the time the hook is declared.
2192 .IP
2193 The default value matches
2194 if the message is either from a user matching the regular expression
2195 given, or if it is from you (if the from address matches
2196 \(lqalternates\(rq) and is to or cc'ed to a user matching the given
2197 regular expression.
2198
2199
2200 .TP
2201 .B delete
2202 .nf
2203 Type: quadoption
2204 Default: ask\-yes
2205 .fi
2206 .IP
2207 Controls whether or not messages are really deleted when closing or
2208 synchronizing a mailbox. If set to \fIyes\fP, messages marked for
2209 deleting will automatically be purged without prompting. If set to
2210 \fIno\fP, messages marked for deletion will be kept in the mailbox.
2211 .IP
2212 This option is ignored for maildir\-style mailboxes when $maildir_trash
2213 is set.
2214
2215
2216 .TP
2217 .B delete_untag
2218 .nf
2219 Type: boolean
2220 Default: yes
2221 .fi
2222 .IP
2223 If this option is \fIset\fP, mutt will untag messages when marking them
2224 for deletion. This applies when you either explicitly delete a message,
2225 or when you save it to another folder.
2226
2227
2228 .TP
2229 .B digest_collapse
2230 .nf
2231 Type: boolean
2232 Default: yes
2233 .fi
2234 .IP
2235 If this option is \fIset\fP, mutt's received\-attachments menu will not show the subparts of
2236 individual messages in a multipart/digest. To see these subparts, press \(lqv\(rq on that menu.
2237
2238
2239 .TP
2240 .B display_filter
2241 .nf
2242 Type: path
2243 Default: \(lq\(rq
2244 .fi
2245 .IP
2246 When set, specifies a command used to filter messages. When a message
2247 is viewed it is passed as standard input to $display_filter, and the
2248 filtered message is read from the standard output.
2249
2250
2251 .TP
2252 .B dotlock_program
2253 .nf
2254 Type: path
2255 Default: \(lq/usr/bin/mutt_dotlock\(rq
2256 .fi
2257 .IP
2258 Contains the path of the \fBmutt_dotlock(1)\fP binary to be used by
2259 mutt.
2260
2261
2262 .TP
2263 .B dsn_notify
2264 .nf
2265 Type: string
2266 Default: \(lq\(rq
2267 .fi
2268 .IP
2269 This variable sets the request for when notification is returned. The
2270 string consists of a comma separated list (no spaces!) of one or more
2271 of the following: \fInever\fP, to never request notification,
2272 \fIfailure\fP, to request notification on transmission failure,
2273 \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be
2274 notified of successful transmission.
2275 .IP
2276 Example:
2277
2278 .IP
2279 .EX
2280 set dsn_notify=\(rqfailure,delay\(rq
2281
2282 .EE
2283 .IP
2284 \fBNote:\fP when using $sendmail for delivery, you should not enable
2285 this unless you are either using Sendmail 8.8.x or greater or a MTA
2286 providing a \fBsendmail(1)\fP\-compatible interface supporting the \fB\-N\fP option
2287 for DSN. For SMTP delivery, DSN support is auto\-detected so that it
2288 depends on the server whether DSN will be used or not.
2289
2290
2291 .TP
2292 .B dsn_return
2293 .nf
2294 Type: string
2295 Default: \(lq\(rq
2296 .fi
2297 .IP
2298 This variable controls how much of your message is returned in DSN
2299 messages. It may be set to either \fIhdrs\fP to return just the
2300 message header, or \fIfull\fP to return the full message.
2301 .IP
2302 Example:
2303
2304 .IP
2305 .EX
2306 set dsn_return=hdrs
2307
2308 .EE
2309 .IP
2310 \fBNote:\fP when using $sendmail for delivery, you should not enable
2311 this unless you are either using Sendmail 8.8.x or greater or a MTA
2312 providing a \fBsendmail(1)\fP\-compatible interface supporting the \fB\-R\fP option
2313 for DSN. For SMTP delivery, DSN support is auto\-detected so that it
2314 depends on the server whether DSN will be used or not.
2315
2316
2317 .TP
2318 .B duplicate_threads
2319 .nf
2320 Type: boolean
2321 Default: yes
2322 .fi
2323 .IP
2324 This variable controls whether mutt, when $sort is set to \fIthreads\fP, threads
2325 messages with the same Message\-Id together. If it is \fIset\fP, it will indicate
2326 that it thinks they are duplicates of each other with an equals sign
2327 in the thread tree.
2328
2329
2330 .TP
2331 .B edit_headers
2332 .nf
2333 Type: boolean
2334 Default: no
2335 .fi
2336 .IP
2337 This option allows you to edit the header of your outgoing messages
2338 along with the body of your message.
2339 .IP
2340 Although the compose menu may have localized header labels, the
2341 labels passed to your editor will be standard RFC 2822 headers,
2342 (e.g. To:, Cc:, Subject:). Headers added in your editor must
2343 also be RFC 2822 headers, or one of the pseudo headers listed in
2344 \(lqedit-header\(rq. Mutt will not understand localized header
2345 labels, just as it would not when parsing an actual email.
2346 .IP
2347 \fBNote\fP that changes made to the References: and Date: headers are
2348 ignored for interoperability reasons.
2349
2350
2351 .TP
2352 .B editor
2353 .nf
2354 Type: path
2355 Default: \(lq\(rq
2356 .fi
2357 .IP
2358 This variable specifies which editor is used by mutt.
2359 It defaults to the value of the \fB$VISUAL\fP, or \fB$EDITOR\fP, environment
2360 variable, or to the string \(lqvi\(rq if neither of those are set.
2361 .IP
2362 The \fB$editor\fP string may contain a \fI%s\fP escape, which will be replaced by the name
2363 of the file to be edited. If the \fI%s\fP escape does not appear in \fB$editor\fP, a
2364 space and the name to be edited are appended.
2365 .IP
2366 The resulting string is then executed by running
2367
2368 .IP
2369 .EX
2370 sh \-c 'string'
2371
2372 .EE
2373 .IP
2374 where \fIstring\fP is the expansion of \fB$editor\fP described above.
2375
2376
2377 .TP
2378 .B encode_from
2379 .nf
2380 Type: boolean
2381 Default: no
2382 .fi
2383 .IP
2384 When \fIset\fP, mutt will quoted\-printable encode messages when
2385 they contain the string \(lqFrom \(rq (note the trailing space) in the beginning of a line.
2386 This is useful to avoid the tampering certain mail delivery and transport
2387 agents tend to do with messages (in order to prevent tools from
2388 misinterpreting the line as a mbox message separator).
2389
2390
2391 .TP
2392 .B entropy_file
2393 .nf
2394 Type: path
2395 Default: \(lq\(rq
2396 .fi
2397 .IP
2398 The file which includes random data that is used to initialize SSL
2399 library functions. (OpenSSL only)
2400
2401
2402 .TP
2403 .B envelope_from_address
2404 .nf
2405 Type: e-mail address
2406 Default: \(lq\(rq
2407 .fi
2408 .IP
2409 Manually sets the \fIenvelope\fP sender for outgoing messages.
2410 This value is ignored if $use_envelope_from is \fIunset\fP.
2411
2412
2413 .TP
2414 .B error_history
2415 .nf
2416 Type: number
2417 Default: 30
2418 .fi
2419 .IP
2420 This variable controls the size (in number of strings remembered)
2421 of the error messages displayed by mutt. These can be shown with
2422 the \fB<error\-history>\fP function. The history is cleared each
2423 time this variable is set.
2424
2425
2426 .TP
2427 .B escape
2428 .nf
2429 Type: string
2430 Default: \(lq~\(rq
2431 .fi
2432 .IP
2433 Escape character to use for functions in the built\-in editor.
2434
2435
2436 .TP
2437 .B fast_reply
2438 .nf
2439 Type: boolean
2440 Default: no
2441 .fi
2442 .IP
2443 When \fIset\fP, the initial prompt for recipients and subject are skipped
2444 when replying to messages, and the initial prompt for subject is
2445 skipped when forwarding messages.
2446 .IP
2447 \fBNote:\fP this variable has no effect when the $autoedit
2448 variable is \fIset\fP.
2449
2450
2451 .TP
2452 .B fcc_attach
2453 .nf
2454 Type: quadoption
2455 Default: yes
2456 .fi
2457 .IP
2458 This variable controls whether or not attachments on outgoing messages
2459 are saved along with the main body of your message.
2460 .IP
2461 Note: $fcc_before_send forces the default (set) behavior of this option.
2462
2463
2464 .TP
2465 .B fcc_before_send
2466 .nf
2467 Type: boolean
2468 Default: no
2469 .fi
2470 .IP
2471 When this variable is \fIset\fP, FCCs will occur before sending
2472 the message. Before sending, the message cannot be manipulated,
2473 so it will be stored the exact same as sent:
2474 $fcc_attach and $fcc_clear will be ignored (using their default
2475 values).
2476 .IP
2477 When \fIunset\fP, the default, FCCs will occur after sending.
2478 Variables $fcc_attach and $fcc_clear will be respected, allowing
2479 it to be stored without attachments or encryption/signing if
2480 desired.
2481
2482
2483 .TP
2484 .B fcc_clear
2485 .nf
2486 Type: boolean
2487 Default: no
2488 .fi
2489 .IP
2490 When this variable is \fIset\fP, FCCs will be stored unencrypted and
2491 unsigned, even when the actual message is encrypted and/or
2492 signed.
2493 .IP
2494 Note: $fcc_before_send forces the default (unset) behavior of this option.
2495 (PGP only)
2496 .IP
2497 See also $pgp_self_encrypt, $smime_self_encrypt.
2498
2499
2500 .TP
2501 .B fcc_delimiter
2502 .nf
2503 Type: string
2504 Default: \(lq\(rq
2505 .fi
2506 .IP
2507 When specified, this allows the ability to Fcc to more than one
2508 mailbox. The fcc value will be split by this delimiter and Mutt
2509 will evaluate each part as a mailbox separately.
2510 .IP
2511 See $record, \(lqfcc-hook\(rq, and \(lqfcc-save-hook\(rq.
2512
2513
2514 .TP
2515 .B flag_safe
2516 .nf
2517 Type: boolean
2518 Default: no
2519 .fi
2520 .IP
2521 If set, flagged messages cannot be deleted.
2522
2523
2524 .TP
2525 .B folder
2526 .nf
2527 Type: path
2528 Default: \(lq~/Mail\(rq
2529 .fi
2530 .IP
2531 Specifies the default location of your mailboxes. A \(lq+\(rq or \(lq=\(rq at the
2532 beginning of a pathname will be expanded to the value of this
2533 variable. Note that if you change this variable (from the default)
2534 value you need to make sure that the assignment occurs \fIbefore\fP
2535 you use \(lq+\(rq or \(lq=\(rq for any other variables since expansion takes place
2536 when handling the \(lqmailboxes\(rq command.
2537
2538
2539 .TP
2540 .B folder_format
2541 .nf
2542 Type: string
2543 Default: \(lq%2C %t %N %F %2l %\-8.8u %\-8.8g %8s %d %f\(rq
2544 .fi
2545 .IP
2546 This variable allows you to customize the file browser display to your
2547 personal taste. This string is similar to $index_format, but has
2548 its own set of \fBprintf(3)\fP\-like sequences:
2549 .RS
2550 .PD 0
2551 .TP
2552 %C
2553 current file number
2554 .TP
2555 %d
2556 date/time folder was last modified
2557 .TP
2558 %D
2559 date/time folder was last modified using $date_format.
2560 .TP
2561 %f
2562 filename (\(lq/\(rq is appended to directory names,
2563 \(lq@\(rq to symbolic links and \(lq*\(rq to executable
2564 files)
2565 .TP
2566 %F
2567 file permissions
2568 .TP
2569 %g
2570 group name (or numeric gid, if missing)
2571 .TP
2572 %l
2573 number of hard links
2574 .TP
2575 %m
2576 number of messages in the mailbox *
2577 .TP
2578 %n
2579 number of unread messages in the mailbox *
2580 .TP
2581 %N
2582 N if mailbox has new mail, blank otherwise
2583 .TP
2584 %s
2585 size in bytes (see formatstrings-size)
2586 .TP
2587 %t
2588 \(lq*\(rq if the file is tagged, blank otherwise
2589 .TP
2590 %u
2591 owner name (or numeric uid, if missing)
2592 .TP
2593 %>X
2594 right justify the rest of the string and pad with character \(lqX\(rq
2595 .TP
2596 %|X
2597 pad to the end of the line with character \(lqX\(rq
2598 .TP
2599 %*X
2600 soft\-fill with character \(lqX\(rq as pad
2601 .RE
2602 .PD 1
2603 .IP
2604 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
2605 .IP
2606 * = can be optionally printed if nonzero
2607 .IP
2608 %m, %n, and %N only work for monitored mailboxes.
2609 %m requires $mail_check_stats to be set.
2610 %n requires $mail_check_stats to be set (except for IMAP mailboxes).
2611
2612
2613 .TP
2614 .B followup_to
2615 .nf
2616 Type: boolean
2617 Default: yes
2618 .fi
2619 .IP
2620 Controls whether or not the \(lqMail\-Followup\-To:\(rq header field is
2621 generated when sending mail. When \fIset\fP, Mutt will generate this
2622 field when you are replying to a known mailing list, specified with
2623 the \(lqsubscribe\(rq or \(lqlists\(rq commands.
2624 .IP
2625 This field has two purposes. First, preventing you from
2626 receiving duplicate copies of replies to messages which you send
2627 to mailing lists, and second, ensuring that you do get a reply
2628 separately for any messages sent to known lists to which you are
2629 not subscribed.
2630 .IP
2631 The header will contain only the list's address
2632 for subscribed lists, and both the list address and your own
2633 email address for unsubscribed lists. Without this header, a
2634 group reply to your message sent to a subscribed list will be
2635 sent to both the list and your address, resulting in two copies
2636 of the same email for you.
2637
2638
2639 .TP
2640 .B force_name
2641 .nf
2642 Type: boolean
2643 Default: no
2644 .fi
2645 .IP
2646 This variable is similar to $save_name, except that Mutt will
2647 store a copy of your outgoing message by the username of the address
2648 you are sending to even if that mailbox does not exist.
2649 .IP
2650 Also see the $record variable.
2651
2652
2653 .TP
2654 .B forward_attachments
2655 .nf
2656 Type: quadoption
2657 Default: ask\-yes
2658 .fi
2659 .IP
2660 When forwarding inline (i.e. $mime_forward \fIunset\fP or
2661 answered with \(lqno\(rq and $forward_decode \fIset\fP), attachments
2662 which cannot be decoded in a reasonable manner will be attached
2663 to the newly composed message if this quadoption is \fIset\fP or
2664 answered with \(lqyes\(rq.
2665
2666
2667 .TP
2668 .B forward_attribution_intro
2669 .nf
2670 Type: string (localized)
2671 Default: \(lq\-\-\-\-\- Forwarded message from %f \-\-\-\-\-\(rq
2672 .fi
2673 .IP
2674 This is the string that will precede a message which has been forwarded
2675 in the main body of a message (when $mime_forward is unset).
2676 For a full listing of defined \fBprintf(3)\fP\-like sequences see
2677 the section on $index_format. See also $attribution_locale.
2678
2679
2680 .TP
2681 .B forward_attribution_trailer
2682 .nf
2683 Type: string (localized)
2684 Default: \(lq\-\-\-\-\- End forwarded message \-\-\-\-\-\(rq
2685 .fi
2686 .IP
2687 This is the string that will follow a message which has been forwarded
2688 in the main body of a message (when $mime_forward is unset).
2689 For a full listing of defined \fBprintf(3)\fP\-like sequences see
2690 the section on $index_format. See also $attribution_locale.
2691
2692
2693 .TP
2694 .B forward_decode
2695 .nf
2696 Type: boolean
2697 Default: yes
2698 .fi
2699 .IP
2700 Controls the decoding of complex MIME messages into \fBtext/plain\fP when
2701 forwarding a message. The message header is also RFC2047 decoded.
2702 This variable is only used, if $mime_forward is \fIunset\fP,
2703 otherwise $mime_forward_decode is used instead.
2704
2705
2706 .TP
2707 .B forward_decrypt
2708 .nf
2709 Type: quadoption
2710 Default: yes
2711 .fi
2712 .IP
2713 This quadoption controls the handling of encrypted messages when
2714 forwarding or attaching a message. When set to or answered
2715 \(lqyes\(rq, the outer layer of encryption is stripped off.
2716 .IP
2717 This variable is used if $mime_forward is \fIset\fP and
2718 $mime_forward_decode is \fIunset\fP. It is also used when
2719 attaching a message via \fB<attach\-message>\fP in the compose
2720 menu. (PGP only)
2721
2722
2723 .TP
2724 .B forward_edit
2725 .nf
2726 Type: quadoption
2727 Default: yes
2728 .fi
2729 .IP
2730 This quadoption controls whether or not the user is automatically
2731 placed in the editor when forwarding messages. For those who always want
2732 to forward with no modification, use a setting of \(lqno\(rq.
2733
2734
2735 .TP
2736 .B forward_format
2737 .nf
2738 Type: string
2739 Default: \(lq[%a: %s]\(rq
2740 .fi
2741 .IP
2742 This variable controls the default subject when forwarding a message.
2743 It uses the same format sequences as the $index_format variable.
2744
2745
2746 .TP
2747 .B forward_quote
2748 .nf
2749 Type: boolean
2750 Default: no
2751 .fi
2752 .IP
2753 When \fIset\fP, forwarded messages included in the main body of the
2754 message (when $mime_forward is \fIunset\fP) will be quoted using
2755 $indent_string.
2756
2757
2758 .TP
2759 .B from
2760 .nf
2761 Type: e-mail address
2762 Default: \(lq\(rq
2763 .fi
2764 .IP
2765 When \fIset\fP, this variable contains a default from address. It
2766 can be overridden using \(lqmy_hdr\(rq (including from a \(lqsend-hook\(rq) and
2767 $reverse_name. This variable is ignored if $use_from is \fIunset\fP.
2768 .IP
2769 This setting defaults to the contents of the environment variable \fB$EMAIL\fP.
2770
2771
2772 .TP
2773 .B gecos_mask
2774 .nf
2775 Type: regular expression
2776 Default: \(lq^[^,]*\(rq
2777 .fi
2778 .IP
2779 A regular expression used by mutt to parse the GECOS field of a password
2780 entry when expanding the alias. The default value
2781 will return the string up to the first \(lq,\(rq encountered.
2782 If the GECOS field contains a string like \(lqlastname, firstname\(rq then you
2783 should set it to \(lq\fB.*\fP\(rq.
2784 .IP
2785 This can be useful if you see the following behavior: you address an e\-mail
2786 to user ID \(lqstevef\(rq whose full name is \(lqSteve Franklin\(rq. If mutt expands
2787 \(lqstevef\(rq to \(lq\(rqFranklin\(rq [email protected]\(rq then you should set the $gecos_mask to
2788 a regular expression that will match the whole name so mutt will expand
2789 \(lqFranklin\(rq to \(lqFranklin, Steve\(rq.
2790
2791
2792 .TP
2793 .B hdrs
2794 .nf
2795 Type: boolean
2796 Default: yes
2797 .fi
2798 .IP
2799 When \fIunset\fP, the header fields normally added by the \(lqmy_hdr\(rq
2800 command are not created. This variable \fImust\fP be unset before
2801 composing a new message or replying in order to take effect. If \fIset\fP,
2802 the user defined header fields are added to every new message.
2803
2804
2805 .TP
2806 .B header
2807 .nf
2808 Type: boolean
2809 Default: no
2810 .fi
2811 .IP
2812 When \fIset\fP, this variable causes Mutt to include the header
2813 of the message you are replying to into the edit buffer.
2814 The $weed setting applies.
2815
2816
2817 .TP
2818 .B header_cache
2819 .nf
2820 Type: path
2821 Default: \(lq\(rq
2822 .fi
2823 .IP
2824 This variable points to the header cache database.
2825 If pointing to a directory Mutt will contain a header cache
2826 database file per folder, if pointing to a file that file will
2827 be a single global header cache. By default it is \fIunset\fP so no header
2828 caching will be used. If pointing to a directory, it must be
2829 created in advance.
2830 .IP
2831 Header caching can greatly improve speed when opening POP, IMAP
2832 MH or Maildir folders, see \(lqcaching\(rq for details.
2833
2834
2835 .TP
2836 .B header_cache_compress
2837 .nf
2838 Type: boolean
2839 Default: yes
2840 .fi
2841 .IP
2842 When mutt is compiled with qdbm, tokyocabinet, or kyotocabinet as header
2843 cache backend, this option determines whether the database will be compressed.
2844 Compression results in database files roughly being one fifth
2845 of the usual diskspace, but the decompression can result in a
2846 slower opening of cached folder(s) which in general is still
2847 much faster than opening non header cached folders.
2848
2849
2850 .TP
2851 .B header_cache_pagesize
2852 .nf
2853 Type: number (long)
2854 Default: 16384
2855 .fi
2856 .IP
2857 When mutt is compiled with either gdbm or bdb4 as the header cache backend,
2858 this option changes the database page size. Too large or too small
2859 values can waste space, memory, or CPU time. The default should be more
2860 or less optimal for most use cases.
2861
2862
2863 .TP
2864 .B header_color_partial
2865 .nf
2866 Type: boolean
2867 Default: no
2868 .fi
2869 .IP
2870 When \fIset\fP, color header regexps behave like color body regexps:
2871 color is applied to the exact text matched by the regexp. When
2872 \fIunset\fP, color is applied to the entire header.
2873 .IP
2874 One use of this option might be to apply color to just the header labels.
2875 .IP
2876 See \(lqcolor\(rq for more details.
2877
2878
2879 .TP
2880 .B help
2881 .nf
2882 Type: boolean
2883 Default: yes
2884 .fi
2885 .IP
2886 When \fIset\fP, help lines describing the bindings for the major functions
2887 provided by each menu are displayed on the first line of the screen.
2888 .IP
2889 \fBNote:\fP The binding will not be displayed correctly if the
2890 function is bound to a sequence rather than a single keystroke. Also,
2891 the help line may not be updated if a binding is changed while Mutt is
2892 running. Since this variable is primarily aimed at new users, neither
2893 of these should present a major problem.
2894
2895
2896 .TP
2897 .B hidden_host
2898 .nf
2899 Type: boolean
2900 Default: no
2901 .fi
2902 .IP
2903 When \fIset\fP, mutt will skip the host name part of $hostname variable
2904 when adding the domain part to addresses. This variable does not
2905 affect the generation of Message\-IDs, and it will not lead to the
2906 cut\-off of first\-level domains.
2907
2908
2909 .TP
2910 .B hide_limited
2911 .nf
2912 Type: boolean
2913 Default: no
2914 .fi
2915 .IP
2916 When \fIset\fP, mutt will not show the presence of messages that are hidden
2917 by limiting, in the thread tree.
2918
2919
2920 .TP
2921 .B hide_missing
2922 .nf
2923 Type: boolean
2924 Default: yes
2925 .fi
2926 .IP
2927 When \fIset\fP, mutt will not show the presence of missing messages in the
2928 thread tree.
2929
2930
2931 .TP
2932 .B hide_thread_subject
2933 .nf
2934 Type: boolean
2935 Default: yes
2936 .fi
2937 .IP
2938 When \fIset\fP, mutt will not show the subject of messages in the thread
2939 tree that have the same subject as their parent or closest previously
2940 displayed sibling.
2941
2942
2943 .TP
2944 .B hide_top_limited
2945 .nf
2946 Type: boolean
2947 Default: no
2948 .fi
2949 .IP
2950 When \fIset\fP, mutt will not show the presence of messages that are hidden
2951 by limiting, at the top of threads in the thread tree. Note that when
2952 $hide_limited is \fIset\fP, this option will have no effect.
2953
2954
2955 .TP
2956 .B hide_top_missing
2957 .nf
2958 Type: boolean
2959 Default: yes
2960 .fi
2961 .IP
2962 When \fIset\fP, mutt will not show the presence of missing messages at the
2963 top of threads in the thread tree. Note that when $hide_missing is
2964 \fIset\fP, this option will have no effect.
2965
2966
2967 .TP
2968 .B history
2969 .nf
2970 Type: number
2971 Default: 10
2972 .fi
2973 .IP
2974 This variable controls the size (in number of strings remembered) of
2975 the string history buffer per category. The buffer is cleared each time the
2976 variable is set.
2977
2978
2979 .TP
2980 .B history_file
2981 .nf
2982 Type: path
2983 Default: \(lq~/.mutthistory\(rq
2984 .fi
2985 .IP
2986 The file in which Mutt will save its history.
2987 .IP
2988 Also see $save_history.
2989
2990
2991 .TP
2992 .B history_remove_dups
2993 .nf
2994 Type: boolean
2995 Default: no
2996 .fi
2997 .IP
2998 When \fIset\fP, all of the string history will be scanned for duplicates
2999 when a new entry is added. Duplicate entries in the $history_file will
3000 also be removed when it is periodically compacted.
3001
3002
3003 .TP
3004 .B honor_disposition
3005 .nf
3006 Type: boolean
3007 Default: no
3008 .fi
3009 .IP
3010 When \fIset\fP, Mutt will not display attachments with a
3011 disposition of \(lqattachment\(rq inline even if it could
3012 render the part to plain text. These MIME parts can only
3013 be viewed from the attachment menu.
3014 .IP
3015 If \fIunset\fP, Mutt will render all MIME parts it can
3016 properly transform to plain text.
3017
3018
3019 .TP
3020 .B honor_followup_to
3021 .nf
3022 Type: quadoption
3023 Default: yes
3024 .fi
3025 .IP
3026 This variable controls whether or not a Mail\-Followup\-To header is
3027 honored when group\-replying to a message.
3028
3029
3030 .TP
3031 .B hostname
3032 .nf
3033 Type: string
3034 Default: \(lq\(rq
3035 .fi
3036 .IP
3037 Specifies the fully\-qualified hostname of the system mutt is running on
3038 containing the host's name and the DNS domain it belongs to. It is used
3039 as the domain part (after \(lq@\(rq) for local email addresses as well as
3040 Message\-Id headers.
3041 .IP
3042 Its value is determined at startup as follows: the node's
3043 hostname is first determined by the \fBuname(3)\fP function. The
3044 domain is then looked up using the \fBgethostname(2)\fP and
3045 \fBgetaddrinfo(3)\fP functions. If those calls are unable to
3046 determine the domain, the full value returned by uname is used.
3047 Optionally, Mutt can be compiled with a fixed domain name in
3048 which case a detected one is not used.
3049 .IP
3050 Starting in Mutt 2.0, the operations described in the previous
3051 paragraph are performed after the muttrc is processed, instead of
3052 beforehand. This way, if the DNS operations are creating delays
3053 at startup, you can avoid those by manually setting the value in
3054 your muttrc.
3055 .IP
3056 Also see $use_domain and $hidden_host.
3057
3058
3059 .TP
3060 .B idn_decode
3061 .nf
3062 Type: boolean
3063 Default: yes
3064 .fi
3065 .IP
3066 When \fIset\fP, Mutt will show you international domain names decoded.
3067 Note: You can use IDNs for addresses even if this is \fIunset\fP.
3068 This variable only affects decoding. (IDN only)
3069
3070
3071 .TP
3072 .B idn_encode
3073 .nf
3074 Type: boolean
3075 Default: yes
3076 .fi
3077 .IP
3078 When \fIset\fP, Mutt will encode international domain names using
3079 IDN. Unset this if your SMTP server can handle newer (RFC 6531)
3080 UTF\-8 encoded domains. (IDN only)
3081
3082
3083 .TP
3084 .B ignore_linear_white_space
3085 .nf
3086 Type: boolean
3087 Default: no
3088 .fi
3089 .IP
3090 This option replaces linear\-white\-space between encoded\-word
3091 and text to a single space to prevent the display of MIME\-encoded
3092 \(lqSubject:\(rq field from being divided into multiple lines.
3093
3094
3095 .TP
3096 .B ignore_list_reply_to
3097 .nf
3098 Type: boolean
3099 Default: no
3100 .fi
3101 .IP
3102 Affects the behavior of the \fB<reply>\fP function when replying to
3103 messages from mailing lists (as defined by the \(lqsubscribe\(rq or
3104 \(lqlists\(rq commands). When \fIset\fP, if the \(lqReply\-To:\(rq field is
3105 set to the same value as the \(lqTo:\(rq field, Mutt assumes that the
3106 \(lqReply\-To:\(rq field was set by the mailing list to automate responses
3107 to the list, and will ignore this field. To direct a response to the
3108 mailing list when this option is \fIset\fP, use the \fB<list-reply>\fP
3109 function; \fB<group\-reply>\fP will reply to both the sender and the
3110 list.
3111
3112
3113 .TP
3114 .B imap_authenticators
3115 .nf
3116 Type: string
3117 Default: \(lq\(rq
3118 .fi
3119 .IP
3120 This is a colon\-delimited list of authentication methods mutt may
3121 attempt to use to log in to an IMAP server, in the order mutt should
3122 try them. Authentication methods are either \(lqlogin\(rq or the right
3123 side of an IMAP \(lqAUTH=xxx\(rq capability string, e.g. \(lqdigest\-md5\(rq, \(lqgssapi\(rq
3124 or \(lqcram\-md5\(rq. This option is case\-insensitive. If it's
3125 \fIunset\fP (the default) mutt will try all available methods,
3126 in order from most\-secure to least\-secure.
3127 .IP
3128 Example:
3129
3130 .IP
3131 .EX
3132 set imap_authenticators=\(rqgssapi:cram\-md5:login\(rq
3133
3134 .EE
3135 .IP
3136 \fBNote:\fP Mutt will only fall back to other authentication methods if
3137 the previous methods are unavailable. If a method is available but
3138 authentication fails, mutt will not connect to the IMAP server.
3139
3140
3141 .TP
3142 .B imap_check_subscribed
3143 .nf
3144 Type: boolean
3145 Default: no
3146 .fi
3147 .IP
3148 When \fIset\fP, mutt will fetch the set of subscribed folders from
3149 your server on connection, and add them to the set of mailboxes
3150 it polls for new mail just as if you had issued individual \(lqmailboxes\(rq
3151 commands.
3152
3153
3154 .TP
3155 .B imap_condstore
3156 .nf
3157 Type: boolean
3158 Default: no
3159 .fi
3160 .IP
3161 When \fIset\fP, mutt will use the CONDSTORE extension (RFC 7162)
3162 if advertised by the server. Mutt's current implementation is basic,
3163 used only for initial message fetching and flag updates.
3164 .IP
3165 For some IMAP servers, enabling this will slightly speed up
3166 downloading initial messages. Unfortunately, Gmail is not one
3167 those, and displays worse performance when enabled. Your
3168 mileage may vary.
3169
3170
3171 .TP
3172 .B imap_deflate
3173 .nf
3174 Type: boolean
3175 Default: no
3176 .fi
3177 .IP
3178 When \fIset\fP, mutt will use the COMPRESS=DEFLATE extension (RFC
3179 4978) if advertised by the server.
3180 .IP
3181 In general a good compression efficiency can be achieved, which
3182 speeds up reading large mailboxes also on fairly good connections.
3183
3184
3185 .TP
3186 .B imap_delim_chars
3187 .nf
3188 Type: string
3189 Default: \(lq/.\(rq
3190 .fi
3191 .IP
3192 This contains the list of characters which you would like to treat
3193 as folder separators for displaying IMAP paths. In particular it
3194 helps in using the \(lq=\(rq shortcut for your \fIfolder\fP variable.
3195
3196
3197 .TP
3198 .B imap_fetch_chunk_size
3199 .nf
3200 Type: number (long)
3201 Default: 0
3202 .fi
3203 .IP
3204 When set to a value greater than 0, new headers will be
3205 downloaded in groups of this many headers per request. If you
3206 have a very large mailbox, this might prevent a timeout and
3207 disconnect when opening the mailbox, by sending a FETCH per set
3208 of this many headers, instead of a single FETCH for all new
3209 headers.
3210
3211
3212 .TP
3213 .B imap_headers
3214 .nf
3215 Type: string
3216 Default: \(lq\(rq
3217 .fi
3218 .IP
3219 Mutt requests these header fields in addition to the default headers
3220 (\(lqDate:\(rq, \(lqFrom:\(rq, \(lqSender:\(rq, \(lqSubject:\(rq, \(lqTo:\(rq, \(lqCc:\(rq, \(lqMessage\-Id:\(rq,
3221 \(lqReferences:\(rq, \(lqContent\-Type:\(rq, \(lqContent\-Description:\(rq, \(lqIn\-Reply\-To:\(rq,
3222 \(lqReply\-To:\(rq, \(lqLines:\(rq, \(lqList\-Post:\(rq, \(lqX\-Label:\(rq) from IMAP
3223 servers before displaying the index menu. You may want to add more
3224 headers for spam detection.
3225 .IP
3226 \fBNote:\fP This is a space separated list, items should be uppercase
3227 and not contain the colon, e.g. \(lqX\-BOGOSITY X\-SPAM\-STATUS\(rq for the
3228 \(lqX\-Bogosity:\(rq and \(lqX\-Spam\-Status:\(rq header fields.
3229
3230
3231 .TP
3232 .B imap_idle
3233 .nf
3234 Type: boolean
3235 Default: no
3236 .fi
3237 .IP
3238 When \fIset\fP, mutt will attempt to use the IMAP IDLE extension
3239 to check for new mail in the current mailbox. Some servers
3240 (dovecot was the inspiration for this option) react badly
3241 to mutt's implementation. If your connection seems to freeze
3242 up periodically, try unsetting this.
3243
3244
3245 .TP
3246 .B imap_keepalive
3247 .nf
3248 Type: number
3249 Default: 300
3250 .fi
3251 .IP
3252 This variable specifies the maximum amount of time in seconds that mutt
3253 will wait before polling open IMAP connections, to prevent the server
3254 from closing them before mutt has finished with them. The default is
3255 well within the RFC\-specified minimum amount of time (30 minutes) before
3256 a server is allowed to do this, but in practice the RFC does get
3257 violated every now and then. Reduce this number if you find yourself
3258 getting disconnected from your IMAP server due to inactivity.
3259
3260
3261 .TP
3262 .B imap_list_subscribed
3263 .nf
3264 Type: boolean
3265 Default: no
3266 .fi
3267 .IP
3268 This variable configures whether IMAP folder browsing will look for
3269 only subscribed folders or all folders. This can be toggled in the
3270 IMAP browser with the \fB<toggle\-subscribed>\fP function.
3271
3272
3273 .TP
3274 .B imap_login
3275 .nf
3276 Type: string
3277 Default: \(lq\(rq
3278 .fi
3279 .IP
3280 Your login name on the IMAP server.
3281 .IP
3282 This variable defaults to the value of $imap_user.
3283
3284
3285 .TP
3286 .B imap_oauth_refresh_command
3287 .nf
3288 Type: string
3289 Default: \(lq\(rq
3290 .fi
3291 .IP
3292 The command to run to generate an OAUTH refresh token for
3293 authorizing your connection to your IMAP server. This command will be
3294 run on every connection attempt that uses the OAUTHBEARER authentication
3295 mechanism. See \(lqoauth\(rq for details.
3296
3297
3298 .TP
3299 .B imap_pass
3300 .nf
3301 Type: string
3302 Default: \(lq\(rq
3303 .fi
3304 .IP
3305 Specifies the password for your IMAP account. If \fIunset\fP, Mutt will
3306 prompt you for your password when you invoke the \fB<imap\-fetch\-mail>\fP function
3307 or try to open an IMAP folder.
3308 .IP
3309 \fBWarning\fP: you should only use this option when you are on a
3310 fairly secure machine, because the superuser can read your muttrc even
3311 if you are the only one who can read the file.
3312
3313
3314 .TP
3315 .B imap_passive
3316 .nf
3317 Type: boolean
3318 Default: yes
3319 .fi
3320 .IP
3321 When \fIset\fP, mutt will not open new IMAP connections to check for new
3322 mail. Mutt will only check for new mail over existing IMAP
3323 connections. This is useful if you don't want to be prompted for
3324 user/password pairs on mutt invocation, or if opening the connection
3325 is slow.
3326
3327
3328 .TP
3329 .B imap_peek
3330 .nf
3331 Type: boolean
3332 Default: yes
3333 .fi
3334 .IP
3335 When \fIset\fP, mutt will avoid implicitly marking your mail as read whenever
3336 you fetch a message from the server. This is generally a good thing,
3337 but can make closing an IMAP folder somewhat slower. This option
3338 exists to appease speed freaks.
3339
3340
3341 .TP
3342 .B imap_pipeline_depth
3343 .nf
3344 Type: number
3345 Default: 15
3346 .fi
3347 .IP
3348 Controls the number of IMAP commands that may be queued up before they
3349 are sent to the server. A deeper pipeline reduces the amount of time
3350 mutt must wait for the server, and can make IMAP servers feel much
3351 more responsive. But not all servers correctly handle pipelined commands,
3352 so if you have problems you might want to try setting this variable to 0.
3353 .IP
3354 \fBNote:\fP Changes to this variable have no effect on open connections.
3355
3356
3357 .TP
3358 .B imap_poll_timeout
3359 .nf
3360 Type: number
3361 Default: 15
3362 .fi
3363 .IP
3364 This variable specifies the maximum amount of time in seconds
3365 that mutt will wait for a response when polling IMAP connections
3366 for new mail, before timing out and closing the connection. Set
3367 to 0 to disable timing out.
3368
3369
3370 .TP
3371 .B imap_qresync
3372 .nf
3373 Type: boolean
3374 Default: no
3375 .fi
3376 .IP
3377 When \fIset\fP, mutt will use the QRESYNC extension (RFC 7162)
3378 if advertised by the server. Mutt's current implementation is basic,
3379 used only for initial message fetching and flag updates.
3380 .IP
3381 Note: this feature is currently experimental. If you experience
3382 strange behavior, such as duplicate or missing messages please
3383 file a bug report to let us know.
3384
3385
3386 .TP
3387 .B imap_reconnect_sleep
3388 .nf
3389 Type: number
3390 Default: 5
3391 .fi
3392 .IP
3393 When mutt fails to reconnect to a lost IMAP server connection, it
3394 will sleep this many seconds before trying again.
3395
3396
3397 .TP
3398 .B imap_reconnect_tries
3399 .nf
3400 Type: number
3401 Default: 3
3402 .fi
3403 .IP
3404 When mutt loses its connection with the IMAP server, it will try
3405 to reconnect this many times before giving up and closing the
3406 connection.
3407
3408
3409 .TP
3410 .B imap_servernoise
3411 .nf
3412 Type: boolean
3413 Default: yes
3414 .fi
3415 .IP
3416 When \fIset\fP, mutt will display warning messages from the IMAP
3417 server as error messages. Since these messages are often
3418 harmless, or generated due to configuration problems on the
3419 server which are out of the users' hands, you may wish to suppress
3420 them at some point.
3421
3422
3423 .TP
3424 .B imap_user
3425 .nf
3426 Type: string
3427 Default: \(lq\(rq
3428 .fi
3429 .IP
3430 The name of the user whose mail you intend to access on the IMAP
3431 server.
3432 .IP
3433 This variable defaults to your user name on the local machine.
3434
3435
3436 .TP
3437 .B implicit_autoview
3438 .nf
3439 Type: boolean
3440 Default: no
3441 .fi
3442 .IP
3443 If set to \(lqyes\(rq, mutt will look for a mailcap entry with the
3444 \(lq\fBcopiousoutput\fP\(rq flag set for \fIevery\fP MIME attachment it doesn't have
3445 an internal viewer defined for. If such an entry is found, mutt will
3446 use the viewer defined in that entry to convert the body part to text
3447 form.
3448
3449
3450 .TP
3451 .B include
3452 .nf
3453 Type: quadoption
3454 Default: ask\-yes
3455 .fi
3456 .IP
3457 Controls whether or not a copy of the message(s) you are replying to
3458 is included in your reply.
3459
3460
3461 .TP
3462 .B include_encrypted
3463 .nf
3464 Type: boolean
3465 Default: no
3466 .fi
3467 .IP
3468 Controls whether or not Mutt includes separately encrypted attachment
3469 contents when replying.
3470 .IP
3471 This variable was added to prevent accidental exposure of encrypted
3472 contents when replying to an attacker. If a previously encrypted message
3473 were attached by the attacker, they could trick an unwary recipient into
3474 decrypting and including the message in their reply.
3475
3476
3477 .TP
3478 .B include_onlyfirst
3479 .nf
3480 Type: boolean
3481 Default: no
3482 .fi
3483 .IP
3484 Controls whether or not Mutt includes only the first attachment
3485 of the message you are replying.
3486
3487
3488 .TP
3489 .B indent_string
3490 .nf
3491 Type: string
3492 Default: \(lq> \(rq
3493 .fi
3494 .IP
3495 Specifies the string to prepend to each line of text quoted in a
3496 message to which you are replying. You are strongly encouraged not to
3497 change this value, as it tends to agitate the more fanatical netizens.
3498 .IP
3499 The value of this option is ignored if $text_flowed is set, because
3500 the quoting mechanism is strictly defined for format=flowed.
3501 .IP
3502 This option is a format string, please see the description of
3503 $index_format for supported \fBprintf(3)\fP\-style sequences.
3504
3505
3506 .TP
3507 .B index_format
3508 .nf
3509 Type: string
3510 Default: \(lq%4C %Z %{%b %d} %\-15.15L (%?l?%4l&%4c?) %s\(rq
3511 .fi
3512 .IP
3513 This variable allows you to customize the message index display to
3514 your personal taste.
3515 .IP
3516 \(lqFormat strings\(rq are similar to the strings used in the C
3517 function \fBprintf(3)\fP to format output (see the man page for more details).
3518 For an explanation of the %? construct, see the $status_format description.
3519 The following sequences are defined in Mutt:
3520 .RS
3521 .PD 0
3522 .TP
3523 %a
3524 address of the author
3525 .TP
3526 %A
3527 reply\-to address (if present; otherwise: address of author)
3528 .TP
3529 %b
3530 filename of the original message folder (think mailbox)
3531 .TP
3532 %B
3533 the list to which the letter was sent, or else the folder name (%b).
3534 .TP
3535 %c
3536 number of characters (bytes) in the message (see formatstrings-size)
3537 .TP
3538 %C
3539 current message number
3540 .TP
3541 %d
3542 date and time of the message in the format specified by
3543 $date_format converted to sender's time zone
3544 .TP
3545 %D
3546 date and time of the message in the format specified by
3547 $date_format converted to the local time zone
3548 .TP
3549 %e
3550 current message number in thread
3551 .TP
3552 %E
3553 number of messages in current thread
3554 .TP
3555 %f
3556 sender (address + real name), either From: or Return\-Path:
3557 .TP
3558 %F
3559 author name, or recipient name if the message is from you
3560 .TP
3561 %H
3562 spam attribute(s) of this message
3563 .TP
3564 %i
3565 message\-id of the current message
3566 .TP
3567 %l
3568 number of lines in the unprocessed message (may not work with
3569 maildir, mh, and IMAP folders)
3570 .TP
3571 %L
3572 If an address in the \(lqTo:\(rq or \(lqCc:\(rq header field matches an address
3573 defined by the users \(lqsubscribe\(rq command, this displays
3574 \(rqTo <list\-name>\(rq, otherwise the same as %F.
3575 .TP
3576 %m
3577 total number of message in the mailbox
3578 .TP
3579 %M
3580 number of hidden messages if the thread is collapsed.
3581 .TP
3582 %N
3583 message score
3584 .TP
3585 %n
3586 author's real name (or address if missing)
3587 .TP
3588 %O
3589 original save folder where mutt would formerly have
3590 stashed the message: list name or recipient name
3591 if not sent to a list
3592 .TP
3593 %P
3594 progress indicator for the built\-in pager (how much of the file has been displayed)
3595 .TP
3596 %r
3597 comma separated list of \(lqTo:\(rq recipients
3598 .TP
3599 %R
3600 comma separated list of \(lqCc:\(rq recipients
3601 .TP
3602 %s
3603 subject of the message
3604 .TP
3605 %S
3606 single character status of the message (\(lqN\(rq/\(lqO\(rq/\(lqD\(rq/\(lqd\(rq/\(lq!\(rq/\(lqr\(rq/\(lq*\(rq)
3607 .TP
3608 %t
3609 \(lqTo:\(rq field (recipients)
3610 .TP
3611 %T
3612 the appropriate character from the $to_chars string
3613 .TP
3614 %u
3615 user (login) name of the author
3616 .TP
3617 %v
3618 first name of the author, or the recipient if the message is from you
3619 .TP
3620 %X
3621 number of attachments
3622 (please see the \(lqattachments\(rq section for possible speed effects)
3623 .TP
3624 %y
3625 \(lqX\-Label:\(rq field, if present
3626 .TP
3627 %Y
3628 \(lqX\-Label:\(rq field, if present, and \fI(1)\fP not at part of a thread tree,
3629 \fI(2)\fP at the top of a thread, or \fI(3)\fP \(lqX\-Label:\(rq is different from
3630 preceding message's \(lqX\-Label:\(rq.
3631 .TP
3632 %Z
3633 a three character set of message status flags.
3634 the first character is new/read/replied flags (\(lqn\(rq/\(lqo\(rq/\(lqr\(rq/\(lqO\(rq/\(lqN\(rq).
3635 the second is deleted or encryption flags (\(lqD\(rq/\(lqd\(rq/\(lqS\(rq/\(lqP\(rq/\(lqs\(rq/\(lqK\(rq).
3636 the third is either tagged/flagged (\(lq*\(rq/\(lq!\(rq), or one of the characters
3637 listed in $to_chars.
3638 .TP
3639 %@name@
3640 insert and evaluate format\-string from the matching
3641 \(lqindex-format-hook\(rq command
3642 .TP
3643 %{fmt}
3644 the date and time of the message is converted to sender's
3645 time zone, and \(lqfmt\(rq is expanded by the library function
3646 \fBstrftime(3)\fP; a leading bang disables locales
3647 .TP
3648 %[fmt]
3649 the date and time of the message is converted to the local
3650 time zone, and \(lqfmt\(rq is expanded by the library function
3651 \fBstrftime(3)\fP; a leading bang disables locales
3652 .TP
3653 %(fmt)
3654 the local date and time when the message was received.
3655 \(lqfmt\(rq is expanded by the library function \fBstrftime(3)\fP;
3656 a leading bang disables locales
3657 .TP
3658 %<fmt>
3659 the current local time. \(lqfmt\(rq is expanded by the library
3660 function \fBstrftime(3)\fP; a leading bang disables locales.
3661 .TP
3662 %>X
3663 right justify the rest of the string and pad with character \(lqX\(rq
3664 .TP
3665 %|X
3666 pad to the end of the line with character \(lqX\(rq
3667 .TP
3668 %*X
3669 soft\-fill with character \(lqX\(rq as pad
3670 .RE
3671 .PD 1
3672 .IP
3673 Note that for mbox/mmdf, \(lq%l\(rq applies to the unprocessed message, and
3674 for maildir/mh, the value comes from the \(lqLines:\(rq header field when
3675 present (the meaning is normally the same). Thus the value depends on
3676 the encodings used in the different parts of the message and has little
3677 meaning in practice.
3678 .IP
3679 \(lqSoft\-fill\(rq deserves some explanation: Normal right\-justification
3680 will print everything to the left of the \(lq%>\(rq, displaying padding and
3681 whatever lies to the right only if there's room. By contrast,
3682 soft\-fill gives priority to the right\-hand side, guaranteeing space
3683 to display it and showing padding only if there's still room. If
3684 necessary, soft\-fill will eat text leftwards to make room for
3685 rightward text.
3686 .IP
3687 Note that these expandos are supported in
3688 \(lqsave-hook\(rq, \(lqfcc-hook\(rq, \(lqfcc-save-hook\(rq, and
3689 \(lqindex-format-hook\(rq.
3690 .IP
3691 They are also supported in the configuration variables $attribution,
3692 $forward_attribution_intro, $forward_attribution_trailer,
3693 $forward_format, $indent_string, $message_format, $pager_format,
3694 and $post_indent_string.
3695
3696
3697 .TP
3698 .B ispell
3699 .nf
3700 Type: path
3701 Default: \(lqaspell \-\-mode=email\(rq
3702 .fi
3703 .IP
3704 How to invoke ispell (GNU's spell\-checking software).
3705
3706
3707 .TP
3708 .B keep_flagged
3709 .nf
3710 Type: boolean
3711 Default: no
3712 .fi
3713 .IP
3714 If \fIset\fP, read messages marked as flagged will not be moved
3715 from your spool mailbox to your $mbox mailbox, or as a result of
3716 a \(lqmbox-hook\(rq command.
3717
3718
3719 .TP
3720 .B local_date_header
3721 .nf
3722 Type: boolean
3723 Default: yes
3724 .fi
3725 .IP
3726 If \fIset\fP, the date in the Date header of emails that you send will be in
3727 your local timezone. If unset a UTC date will be used instead to avoid
3728 leaking information about your current location.
3729
3730
3731 .TP
3732 .B mail_check
3733 .nf
3734 Type: number
3735 Default: 5
3736 .fi
3737 .IP
3738 This variable configures how often (in seconds) mutt should look for
3739 new mail. Also see the $timeout variable.
3740
3741
3742 .TP
3743 .B mail_check_recent
3744 .nf
3745 Type: boolean
3746 Default: yes
3747 .fi
3748 .IP
3749 When \fIset\fP, Mutt will only notify you about new mail that has been received
3750 since the last time you opened the mailbox. When \fIunset\fP, Mutt will notify you
3751 if any new mail exists in the mailbox, regardless of whether you have visited it
3752 recently.
3753
3754
3755 .TP
3756 .B mail_check_stats
3757 .nf
3758 Type: boolean
3759 Default: no
3760 .fi
3761 .IP
3762 When \fIset\fP, mutt will periodically calculate message
3763 statistics of a mailbox while polling for new mail. It will
3764 check for unread, flagged, and total message counts.
3765 (Note: IMAP mailboxes only support unread and total counts).
3766 .IP
3767 Because this operation is more performance intensive, it defaults
3768 to \fIunset\fP, and has a separate option,
3769 $mail_check_stats_interval, to control how often to update these
3770 counts.
3771 .IP
3772 Message statistics can also be explicitly calculated by invoking the
3773 \fB<check\-stats>\fP
3774 function.
3775
3776
3777 .TP
3778 .B mail_check_stats_interval
3779 .nf
3780 Type: number
3781 Default: 60
3782 .fi
3783 .IP
3784 When $mail_check_stats is \fIset\fP, this variable configures
3785 how often (in seconds) mutt will update message counts.
3786
3787
3788 .TP
3789 .B mailcap_path
3790 .nf
3791 Type: string
3792 Default: \(lq\(rq
3793 .fi
3794 .IP
3795 This variable specifies which files to consult when attempting to
3796 display MIME bodies not directly supported by Mutt. The default value
3797 is generated during startup: see the \(lqmailcap\(rq section of the manual.
3798
3799
3800 .TP
3801 .B mailcap_sanitize
3802 .nf
3803 Type: boolean
3804 Default: yes
3805 .fi
3806 .IP
3807 If \fIset\fP, mutt will restrict possible characters in mailcap % expandos
3808 to a well\-defined set of safe characters. This is the safe setting,
3809 but we are not sure it doesn't break some more advanced MIME stuff.
3810 .IP
3811 \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
3812 DOING!\fP
3813
3814
3815 .TP
3816 .B maildir_header_cache_verify
3817 .nf
3818 Type: boolean
3819 Default: yes
3820 .fi
3821 .IP
3822 Check for Maildir unaware programs other than mutt having modified maildir
3823 files when the header cache is in use. This incurs one \fBstat(2)\fP per
3824 message every time the folder is opened (which can be very slow for NFS
3825 folders).
3826
3827
3828 .TP
3829 .B maildir_trash
3830 .nf
3831 Type: boolean
3832 Default: no
3833 .fi
3834 .IP
3835 If \fIset\fP, messages marked as deleted will be saved with the maildir
3836 trashed flag instead of unlinked. \fBNote:\fP this only applies
3837 to maildir\-style mailboxes. Setting it will have no effect on other
3838 mailbox types.
3839
3840
3841 .TP
3842 .B maildir_check_cur
3843 .nf
3844 Type: boolean
3845 Default: no
3846 .fi
3847 .IP
3848 If \fIset\fP, mutt will poll both the new and cur directories of
3849 a maildir folder for new messages. This might be useful if other
3850 programs interacting with the folder (e.g. dovecot) are moving new
3851 messages to the cur directory. Note that setting this option may
3852 slow down polling for new messages in large folders, since mutt has
3853 to scan all cur messages.
3854
3855
3856 .TP
3857 .B mark_macro_prefix
3858 .nf
3859 Type: string
3860 Default: \(lq'\(rq
3861 .fi
3862 .IP
3863 Prefix for macros created using mark\-message. A new macro
3864 automatically generated with \fI<mark\-message>a\fP will be composed
3865 from this prefix and the letter \fIa\fP.
3866
3867
3868 .TP
3869 .B mark_old
3870 .nf
3871 Type: boolean
3872 Default: yes
3873 .fi
3874 .IP
3875 Controls whether or not mutt marks \fInew\fP \fBunread\fP
3876 messages as \fIold\fP if you exit a mailbox without reading them.
3877 With this option \fIset\fP, the next time you start mutt, the messages
3878 will show up with an \(lqO\(rq next to them in the index menu,
3879 indicating that they are old.
3880
3881
3882 .TP
3883 .B markers
3884 .nf
3885 Type: boolean
3886 Default: yes
3887 .fi
3888 .IP
3889 Controls the display of wrapped lines in the internal pager. If set, a
3890 \(lq+\(rq marker is displayed at the beginning of wrapped lines.
3891 .IP
3892 Also see the $smart_wrap variable.
3893
3894
3895 .TP
3896 .B mask
3897 .nf
3898 Type: regular expression
3899 Default: \(lq!^\\.[^.]\(rq
3900 .fi
3901 .IP
3902 A regular expression used in the file browser, optionally preceded by
3903 the \fInot\fP operator \(lq!\(rq. Only files whose names match this mask
3904 will be shown. The match is always case\-sensitive.
3905
3906
3907 .TP
3908 .B mbox
3909 .nf
3910 Type: path
3911 Default: \(lq~/mbox\(rq
3912 .fi
3913 .IP
3914 This specifies the folder into which read mail in your $spoolfile
3915 folder will be appended.
3916 .IP
3917 Also see the $move variable.
3918
3919
3920 .TP
3921 .B mbox_type
3922 .nf
3923 Type: folder magic
3924 Default: mbox
3925 .fi
3926 .IP
3927 The default mailbox type used when creating new folders. May be any of
3928 \(lqmbox\(rq, \(lqMMDF\(rq, \(lqMH\(rq and \(lqMaildir\(rq. This is overridden by the
3929 \fB\-m\fP command\-line option.
3930
3931
3932 .TP
3933 .B menu_context
3934 .nf
3935 Type: number
3936 Default: 0
3937 .fi
3938 .IP
3939 This variable controls the number of lines of context that are given
3940 when scrolling through menus. (Similar to $pager_context.)
3941
3942
3943 .TP
3944 .B menu_move_off
3945 .nf
3946 Type: boolean
3947 Default: yes
3948 .fi
3949 .IP
3950 When \fIunset\fP, the bottom entry of menus will never scroll up past
3951 the bottom of the screen, unless there are less entries than lines.
3952 When \fIset\fP, the bottom entry may move off the bottom.
3953
3954
3955 .TP
3956 .B menu_scroll
3957 .nf
3958 Type: boolean
3959 Default: no
3960 .fi
3961 .IP
3962 When \fIset\fP, menus will be scrolled up or down one line when you
3963 attempt to move across a screen boundary. If \fIunset\fP, the screen
3964 is cleared and the next or previous page of the menu is displayed
3965 (useful for slow links to avoid many redraws).
3966
3967
3968 .TP
3969 .B message_cache_clean
3970 .nf
3971 Type: boolean
3972 Default: no
3973 .fi
3974 .IP
3975 If \fIset\fP, mutt will clean out obsolete entries from the message cache when
3976 the mailbox is synchronized. You probably only want to set it
3977 every once in a while, since it can be a little slow
3978 (especially for large folders).
3979
3980
3981 .TP
3982 .B message_cachedir
3983 .nf
3984 Type: path
3985 Default: \(lq\(rq
3986 .fi
3987 .IP
3988 Set this to a directory and mutt will cache copies of messages from
3989 your IMAP and POP servers here. You are free to remove entries at any
3990 time.
3991 .IP
3992 When setting this variable to a directory, mutt needs to fetch every
3993 remote message only once and can perform regular expression searches
3994 as fast as for local folders.
3995 .IP
3996 Also see the $message_cache_clean variable.
3997
3998
3999 .TP
4000 .B message_format
4001 .nf
4002 Type: string
4003 Default: \(lq%s\(rq
4004 .fi
4005 .IP
4006 This is the string displayed in the \(lqattachment\(rq menu for
4007 attachments of type \fBmessage/rfc822\fP. For a full listing of defined
4008 \fBprintf(3)\fP\-like sequences see the section on $index_format.
4009
4010
4011 .TP
4012 .B message_id_format
4013 .nf
4014 Type: string
4015 Default: \(lq<%z@%f>\(rq
4016 .fi
4017 .IP
4018 This variable describes the format of the Message\-ID generated
4019 when sending messages. Mutt 2.0 introduced a more compact
4020 format, but this variable allows the ability to choose your own
4021 format. The value may end in \(lq|\(rq to invoke an external filter.
4022 See formatstrings-filters.
4023 .IP
4024 Please note that the Message\-ID value follows a strict syntax,
4025 and you are responsible for ensuring correctness if you change
4026 this from the default. In particular, the value must follow the
4027 syntax in RFC 5322: \(lq\fB\(rq<\(rq id\-left \(rq@\(rq id\-right \(rq>\(rq\fP\(rq. No
4028 spaces are allowed, and \fBid\-left\fP should follow the
4029 dot\-atom\-text syntax in the RFC. The \fBid\-right\fP should
4030 generally be left at %f.
4031 .IP
4032 The old Message\-ID format can be used by setting this to:
4033 \(lq\fB<%Y%02m%02d%02H%02M%02S.G%c%p@%f>\fP\(rq
4034 .IP
4035 The following \fBprintf(3)\fP\-style sequences are understood:
4036 .RS
4037 .PD 0
4038 .TP
4039 %c
4040 step counter looping from \(lqA\(rq to \(lqZ\(rq
4041 .TP
4042 %d
4043 current day of the month (GMT)
4044 .TP
4045 %f
4046 $hostname
4047 .TP
4048 %H
4049 current hour using a 24\-hour clock (GMT)
4050 .TP
4051 %m
4052 current month number (GMT)
4053 .TP
4054 %M
4055 current minute of the hour (GMT)
4056 .TP
4057 %p
4058 pid of the running mutt process
4059 .TP
4060 %r
4061 3 bytes of pseudorandom data encoded in Base64
4062 .TP
4063 %S
4064 current second of the minute (GMT)
4065 .TP
4066 %x
4067 1 byte of pseudorandom data hex encoded (example: '1b')
4068 .TP
4069 %Y
4070 current year using 4 digits (GMT)
4071 .TP
4072 %z
4073 4 byte timestamp + 8 bytes of pseudorandom data encoded in Base64
4074 .RE
4075 .PD 1
4076
4077 .TP
4078 .B meta_key
4079 .nf
4080 Type: boolean
4081 Default: no
4082 .fi
4083 .IP
4084 If \fIset\fP, forces Mutt to interpret keystrokes with the high bit (bit 8)
4085 set as if the user had pressed the Esc key and whatever key remains
4086 after having the high bit removed. For example, if the key pressed
4087 has an ASCII value of \fB0xf8\fP, then this is treated as if the user had
4088 pressed Esc then \(lqx\(rq. This is because the result of removing the
4089 high bit from \fB0xf8\fP is \fB0x78\fP, which is the ASCII character
4090 \(lqx\(rq.
4091
4092
4093 .TP
4094 .B metoo
4095 .nf
4096 Type: boolean
4097 Default: no
4098 .fi
4099 .IP
4100 If \fIunset\fP, Mutt will remove your address (see the \(lqalternates\(rq
4101 command) from the list of recipients when replying to a message.
4102
4103
4104 .TP
4105 .B mh_purge
4106 .nf
4107 Type: boolean
4108 Default: no
4109 .fi
4110 .IP
4111 When \fIunset\fP, mutt will mimic mh's behavior and rename deleted messages
4112 to \fI,<old file name>\fP in mh folders instead of really deleting
4113 them. This leaves the message on disk but makes programs reading the folder
4114 ignore it. If the variable is \fIset\fP, the message files will simply be
4115 deleted.
4116 .IP
4117 This option is similar to $maildir_trash for Maildir folders.
4118
4119
4120 .TP
4121 .B mh_seq_flagged
4122 .nf
4123 Type: string
4124 Default: \(lqflagged\(rq
4125 .fi
4126 .IP
4127 The name of the MH sequence used for flagged messages.
4128
4129
4130 .TP
4131 .B mh_seq_replied
4132 .nf
4133 Type: string
4134 Default: \(lqreplied\(rq
4135 .fi
4136 .IP
4137 The name of the MH sequence used to tag replied messages.
4138
4139
4140 .TP
4141 .B mh_seq_unseen
4142 .nf
4143 Type: string
4144 Default: \(lqunseen\(rq
4145 .fi
4146 .IP
4147 The name of the MH sequence used for unseen messages.
4148
4149
4150 .TP
4151 .B mime_forward
4152 .nf
4153 Type: quadoption
4154 Default: no
4155 .fi
4156 .IP
4157 When \fIset\fP, the message you are forwarding will be attached as a
4158 separate \fBmessage/rfc822\fP MIME part instead of included in the main body of the
4159 message. This is useful for forwarding MIME messages so the receiver
4160 can properly view the message as it was delivered to you. If you like
4161 to switch between MIME and not MIME from mail to mail, set this
4162 variable to \(lqask\-no\(rq or \(lqask\-yes\(rq.
4163 .IP
4164 Also see $forward_decode and $mime_forward_decode.
4165
4166
4167 .TP
4168 .B mime_forward_decode
4169 .nf
4170 Type: boolean
4171 Default: no
4172 .fi
4173 .IP
4174 Controls the decoding of complex MIME messages into \fBtext/plain\fP when
4175 forwarding a message while $mime_forward is \fIset\fP. Otherwise
4176 $forward_decode is used instead.
4177
4178
4179 .TP
4180 .B mime_forward_rest
4181 .nf
4182 Type: quadoption
4183 Default: yes
4184 .fi
4185 .IP
4186 When forwarding multiple attachments of a MIME message from the attachment
4187 menu, attachments which cannot be decoded in a reasonable manner will
4188 be attached to the newly composed message if this option is \fIset\fP.
4189
4190
4191 .TP
4192 .B mime_type_query_command
4193 .nf
4194 Type: string
4195 Default: \(lq\(rq
4196 .fi
4197 .IP
4198 This specifies a command to run, to determine the mime type of a
4199 new attachment when composing a message. Unless
4200 $mime_type_query_first is set, this will only be run if the
4201 attachment's extension is not found in the mime.types file.
4202 .IP
4203 The string may contain a \(lq%s\(rq, which will be substituted with the
4204 attachment filename. Mutt will add quotes around the string substituted
4205 for \(lq%s\(rq automatically according to shell quoting rules, so you should
4206 avoid adding your own. If no \(lq%s\(rq is found in the string, Mutt will
4207 append the attachment filename to the end of the string.
4208 .IP
4209 The command should output a single line containing the
4210 attachment's mime type.
4211 .IP
4212 Suggested values are \(lqxdg\-mime query filetype\(rq or
4213 \(lqfile \-bi\(rq.
4214
4215
4216 .TP
4217 .B mime_type_query_first
4218 .nf
4219 Type: boolean
4220 Default: no
4221 .fi
4222 .IP
4223 When \fIset\fP, the $mime_type_query_command will be run before the
4224 mime.types lookup.
4225
4226
4227 .TP
4228 .B mix_entry_format
4229 .nf
4230 Type: string
4231 Default: \(lq%4n %c %\-16s %a\(rq
4232 .fi
4233 .IP
4234 This variable describes the format of a remailer line on the mixmaster
4235 chain selection screen. The following \fBprintf(3)\fP\-like sequences are
4236 supported:
4237 .RS
4238 .PD 0
4239 .TP
4240 %n
4241 The running number on the menu.
4242 .TP
4243 %c
4244 Remailer capabilities.
4245 .TP
4246 %s
4247 The remailer's short name.
4248 .TP
4249 %a
4250 The remailer's e\-mail address.
4251 .RE
4252 .PD 1
4253 .IP
4254 (Mixmaster only)
4255
4256
4257 .TP
4258 .B mixmaster
4259 .nf
4260 Type: path
4261 Default: \(lqmixmaster\(rq
4262 .fi
4263 .IP
4264 This variable contains the path to the Mixmaster binary on your
4265 system. It is used with various sets of parameters to gather the
4266 list of known remailers, and to finally send a message through the
4267 mixmaster chain. (Mixmaster only)
4268
4269
4270 .TP
4271 .B move
4272 .nf
4273 Type: quadoption
4274 Default: no
4275 .fi
4276 .IP
4277 Controls whether or not Mutt will move read messages
4278 from your spool mailbox to your $mbox mailbox, or as a result of
4279 a \(lqmbox-hook\(rq command.
4280
4281
4282 .TP
4283 .B muttlisp_inline_eval
4284 .nf
4285 Type: boolean
4286 Default: no
4287 .fi
4288 .IP
4289 If \fIset\fP, Mutt will evaluate bare parenthesis arguments to commands
4290 as MuttLisp expressions.
4291
4292
4293 .TP
4294 .B narrow_tree
4295 .nf
4296 Type: boolean
4297 Default: no
4298 .fi
4299 .IP
4300 This variable, when \fIset\fP, makes the thread tree narrower, allowing
4301 deeper threads to fit on the screen.
4302
4303
4304 .TP
4305 .B net_inc
4306 .nf
4307 Type: number
4308 Default: 10
4309 .fi
4310 .IP
4311 Operations that expect to transfer a large amount of data over the
4312 network will update their progress every $net_inc kilobytes.
4313 If set to 0, no progress messages will be displayed.
4314 .IP
4315 See also $read_inc, $write_inc and $net_inc.
4316
4317
4318 .TP
4319 .B new_mail_command
4320 .nf
4321 Type: path
4322 Default: \(lq\(rq
4323 .fi
4324 .IP
4325 If \fIset\fP, Mutt will call this command after a new message is received.
4326 See the $status_format documentation for the values that can be formatted
4327 into this command.
4328
4329
4330 .TP
4331 .B pager
4332 .nf
4333 Type: path
4334 Default: \(lqbuiltin\(rq
4335 .fi
4336 .IP
4337 This variable specifies which pager you would like to use to view
4338 messages. The value \(lqbuiltin\(rq means to use the built\-in pager, otherwise this
4339 variable should specify the pathname of the external pager you would
4340 like to use.
4341 .IP
4342 The string may contain a \(lq%s\(rq, which will be substituted with
4343 the generated message filename. Mutt will add quotes around the
4344 string substituted for \(lq%s\(rq automatically according to shell
4345 quoting rules, so you should avoid adding your own. If no \(lq%s\(rq
4346 is found in the string, Mutt will append the message filename to
4347 the end of the string.
4348 .IP
4349 Using an external pager may have some disadvantages: Additional
4350 keystrokes are necessary because you can't call mutt functions
4351 directly from the pager, and screen resizes cause lines longer than
4352 the screen width to be badly formatted in the help menu.
4353 .IP
4354 When using an external pager, also see $prompt_after which defaults
4355 \fIset\fP.
4356
4357
4358 .TP
4359 .B pager_context
4360 .nf
4361 Type: number
4362 Default: 0
4363 .fi
4364 .IP
4365 This variable controls the number of lines of context that are given
4366 when displaying the next or previous page in the internal pager. By
4367 default, Mutt will display the line after the last one on the screen
4368 at the top of the next page (0 lines of context).
4369 .IP
4370 This variable also specifies the amount of context given for search
4371 results. If positive, this many lines will be given before a match,
4372 if 0, the match will be top\-aligned.
4373
4374
4375 .TP
4376 .B pager_format
4377 .nf
4378 Type: string
4379 Default: \(lq\-%Z\- %C/%m: %\-20.20n %s%* \-\- (%P)\(rq
4380 .fi
4381 .IP
4382 This variable controls the format of the one\-line message \(lqstatus\(rq
4383 displayed before each message in either the internal or an external
4384 pager. The valid sequences are listed in the $index_format
4385 section.
4386
4387
4388 .TP
4389 .B pager_index_lines
4390 .nf
4391 Type: number
4392 Default: 0
4393 .fi
4394 .IP
4395 Determines the number of lines of a mini\-index which is shown when in
4396 the pager. The current message, unless near the top or bottom of the
4397 folder, will be roughly one third of the way down this mini\-index,
4398 giving the reader the context of a few messages before and after the
4399 message. This is useful, for example, to determine how many messages
4400 remain to be read in the current thread. One of the lines is reserved
4401 for the status bar from the index, so a setting of 6
4402 will only show 5 lines of the actual index. A value of 0 results in
4403 no index being shown. If the number of messages in the current folder
4404 is less than $pager_index_lines, then the index will only use as
4405 many lines as it needs.
4406
4407
4408 .TP
4409 .B pager_skip_quoted_context
4410 .nf
4411 Type: number
4412 Default: 0
4413 .fi
4414 .IP
4415 Determines the number of lines of context to show before the
4416 unquoted text when using \fB<skip-quoted>\fP. When set to a
4417 positive number at most that many lines of the previous quote are
4418 displayed. If the previous quote is shorter the whole quote is
4419 displayed.
4420
4421
4422 .TP
4423 .B pager_stop
4424 .nf
4425 Type: boolean
4426 Default: no
4427 .fi
4428 .IP
4429 When \fIset\fP, the internal\-pager will \fBnot\fP move to the next message
4430 when you are at the end of a message and invoke the \fB<next\-page>\fP
4431 function.
4432
4433
4434 .TP
4435 .B pattern_format
4436 .nf
4437 Type: string
4438 Default: \(lq%2n %\-15e %d\(rq
4439 .fi
4440 .IP
4441 This variable describes the format of the \(lqpattern completion\(rq menu. The
4442 following \fBprintf(3)\fP\-style sequences are understood:
4443 .RS
4444 .PD 0
4445 .TP
4446 %d
4447 pattern description
4448 .TP
4449 %e
4450 pattern expression
4451 .TP
4452 %n
4453 index number
4454 .RE
4455 .PD 1
4456 .IP
4457
4458
4459 .TP
4460 .B pgp_auto_decode
4461 .nf
4462 Type: boolean
4463 Default: no
4464 .fi
4465 .IP
4466 If \fIset\fP, mutt will automatically attempt to decrypt traditional PGP
4467 messages whenever the user performs an operation which ordinarily would
4468 result in the contents of the message being operated on. For example,
4469 if the user displays a pgp\-traditional message which has not been manually
4470 checked with the \fB<check-traditional-pgp>\fP function, mutt will automatically
4471 check the message for traditional pgp.
4472
4473
4474 .TP
4475 .B pgp_autoinline
4476 .nf
4477 Type: boolean
4478 Default: no
4479 .fi
4480 .IP
4481 This option controls whether Mutt generates old\-style inline
4482 (traditional) PGP encrypted or signed messages under certain
4483 circumstances. This can be overridden by use of the pgp menu,
4484 when inline is not required. The GPGME backend does not support
4485 this option.
4486 .IP
4487 Note that Mutt might automatically use PGP/MIME for messages
4488 which consist of more than a single MIME part. Mutt can be
4489 configured to ask before sending PGP/MIME messages when inline
4490 (traditional) would not work.
4491 .IP
4492 Also see the $pgp_mime_auto variable.
4493 .IP
4494 Also note that using the old\-style PGP message format is \fBstrongly\fP
4495 \fBdeprecated\fP.
4496 (PGP only)
4497
4498
4499 .TP
4500 .B pgp_check_exit
4501 .nf
4502 Type: boolean
4503 Default: yes
4504 .fi
4505 .IP
4506 If \fIset\fP, mutt will check the exit code of the PGP subprocess when
4507 signing or encrypting. A non\-zero exit code means that the
4508 subprocess failed.
4509 (PGP only)
4510
4511
4512 .TP
4513 .B pgp_check_gpg_decrypt_status_fd
4514 .nf
4515 Type: boolean
4516 Default: yes
4517 .fi
4518 .IP
4519 If \fIset\fP, mutt will check the status file descriptor output
4520 of $pgp_decrypt_command and $pgp_decode_command for GnuPG status codes
4521 indicating successful decryption. This will check for the presence of
4522 DECRYPTION_OKAY, absence of DECRYPTION_FAILED, and that all
4523 PLAINTEXT occurs between the BEGIN_DECRYPTION and END_DECRYPTION
4524 status codes.
4525 .IP
4526 If \fIunset\fP, mutt will instead match the status fd output
4527 against $pgp_decryption_okay.
4528 (PGP only)
4529
4530
4531 .TP
4532 .B pgp_clearsign_command
4533 .nf
4534 Type: string
4535 Default: \(lq\(rq
4536 .fi
4537 .IP
4538 This format is used to create an old\-style \(lqclearsigned\(rq PGP
4539 message. Note that the use of this format is \fBstrongly\fP
4540 \fBdeprecated\fP.
4541 .IP
4542 This is a format string, see the $pgp_decode_command command for
4543 possible \fBprintf(3)\fP\-like sequences.
4544 (PGP only)
4545
4546
4547 .TP
4548 .B pgp_decode_command
4549 .nf
4550 Type: string
4551 Default: \(lq\(rq
4552 .fi
4553 .IP
4554 This format strings specifies a command which is used to decode
4555 application/pgp attachments.
4556 .IP
4557 The PGP command formats have their own set of \fBprintf(3)\fP\-like sequences:
4558 .RS
4559 .PD 0
4560 .TP
4561 %p
4562 Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
4563 string otherwise. Note: This may be used with a %? construct.
4564 .TP
4565 %f
4566 Expands to the name of a file containing a message.
4567 .TP
4568 %s
4569 Expands to the name of a file containing the signature part
4570 of a \fBmultipart/signed\fP attachment when verifying it.
4571 .TP
4572 %a
4573 The value of $pgp_sign_as if set, otherwise the value
4574 of $pgp_default_key.
4575 .TP
4576 %r
4577 One or more key IDs (or fingerprints if available).
4578 .RE
4579 .PD 1
4580 .IP
4581 For examples on how to configure these formats for the various versions
4582 of PGP which are floating around, see the pgp and gpg sample configuration files in
4583 the \fBsamples/\fP subdirectory which has been installed on your system
4584 alongside the documentation.
4585 (PGP only)
4586
4587
4588 .TP
4589 .B pgp_decrypt_command
4590 .nf
4591 Type: string
4592 Default: \(lq\(rq
4593 .fi
4594 .IP
4595 This command is used to decrypt a PGP encrypted message.
4596 .IP
4597 This is a format string, see the $pgp_decode_command command for
4598 possible \fBprintf(3)\fP\-like sequences.
4599 (PGP only)
4600
4601
4602 .TP
4603 .B pgp_decryption_okay
4604 .nf
4605 Type: regular expression
4606 Default: \(lq\(rq
4607 .fi
4608 .IP
4609 If you assign text to this variable, then an encrypted PGP
4610 message is only considered successfully decrypted if the output
4611 from $pgp_decrypt_command contains the text. This is used to
4612 protect against a spoofed encrypted message, with multipart/encrypted
4613 headers but containing a block that is not actually encrypted.
4614 (e.g. simply signed and ascii armored text).
4615 .IP
4616 Note that if $pgp_check_gpg_decrypt_status_fd is set, this variable
4617 is ignored.
4618 (PGP only)
4619
4620
4621 .TP
4622 .B pgp_default_key
4623 .nf
4624 Type: string
4625 Default: \(lq\(rq
4626 .fi
4627 .IP
4628 This is the default key\-pair to use for PGP operations. It will be
4629 used for encryption (see $postpone_encrypt and $pgp_self_encrypt).
4630 .IP
4631 It will also be used for signing unless $pgp_sign_as is set.
4632 .IP
4633 The (now deprecated) \fIpgp_self_encrypt_as\fP is an alias for this
4634 variable, and should no longer be used.
4635 (PGP only)
4636
4637
4638 .TP
4639 .B pgp_encrypt_only_command
4640 .nf
4641 Type: string
4642 Default: \(lq\(rq
4643 .fi
4644 .IP
4645 This command is used to encrypt a body part without signing it.
4646 .IP
4647 This is a format string, see the $pgp_decode_command command for
4648 possible \fBprintf(3)\fP\-like sequences.
4649 (PGP only)
4650
4651
4652 .TP
4653 .B pgp_encrypt_sign_command
4654 .nf
4655 Type: string
4656 Default: \(lq\(rq
4657 .fi
4658 .IP
4659 This command is used to both sign and encrypt a body part.
4660 .IP
4661 This is a format string, see the $pgp_decode_command command for
4662 possible \fBprintf(3)\fP\-like sequences.
4663 (PGP only)
4664
4665
4666 .TP
4667 .B pgp_entry_format
4668 .nf
4669 Type: string
4670 Default: \(lq%4n %t%f %4l/0x%k %\-4a %2c %u\(rq
4671 .fi
4672 .IP
4673 This variable allows you to customize the PGP key selection menu to
4674 your personal taste. This string is similar to $index_format, but
4675 has its own set of \fBprintf(3)\fP\-like sequences:
4676 .RS
4677 .PD 0
4678 .TP
4679 %n
4680 number
4681 .TP
4682 %k
4683 key id
4684 .TP
4685 %u
4686 user id
4687 .TP
4688 %a
4689 algorithm
4690 .TP
4691 %l
4692 key length
4693 .TP
4694 %f
4695 flags
4696 .TP
4697 %c
4698 capabilities
4699 .TP
4700 %t
4701 trust/validity of the key\-uid association
4702 .TP
4703 %[<s>]
4704 date of the key where <s> is an \fBstrftime(3)\fP expression
4705 .RE
4706 .PD 1
4707 .IP
4708 (PGP only)
4709
4710
4711 .TP
4712 .B pgp_export_command
4713 .nf
4714 Type: string
4715 Default: \(lq\(rq
4716 .fi
4717 .IP
4718 This command is used to export a public key from the user's
4719 key ring.
4720 .IP
4721 This is a format string, see the $pgp_decode_command command for
4722 possible \fBprintf(3)\fP\-like sequences.
4723 (PGP only)
4724
4725
4726 .TP
4727 .B pgp_getkeys_command
4728 .nf
4729 Type: string
4730 Default: \(lq\(rq
4731 .fi
4732 .IP
4733 This command is invoked whenever Mutt needs to fetch the public key associated with
4734 an email address. Of the sequences supported by $pgp_decode_command, %r is
4735 the only \fBprintf(3)\fP\-like sequence used with this format. Note that
4736 in this case, %r expands to the email address, not the public key ID (the key ID is
4737 unknown, which is why Mutt is invoking this command).
4738 (PGP only)
4739
4740
4741 .TP
4742 .B pgp_good_sign
4743 .nf
4744 Type: regular expression
4745 Default: \(lq\(rq
4746 .fi
4747 .IP
4748 If you assign a text to this variable, then a PGP signature is only
4749 considered verified if the output from $pgp_verify_command contains
4750 the text. Use this variable if the exit code from the command is 0
4751 even for bad signatures.
4752 (PGP only)
4753
4754
4755 .TP
4756 .B pgp_ignore_subkeys
4757 .nf
4758 Type: boolean
4759 Default: yes
4760 .fi
4761 .IP
4762 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
4763 the principal key will inherit the subkeys' capabilities. \fIUnset\fP this
4764 if you want to play interesting key selection games.
4765 (PGP only)
4766
4767
4768 .TP
4769 .B pgp_import_command
4770 .nf
4771 Type: string
4772 Default: \(lq\(rq
4773 .fi
4774 .IP
4775 This command is used to import a key from a message into
4776 the user's public key ring.
4777 .IP
4778 This is a format string, see the $pgp_decode_command command for
4779 possible \fBprintf(3)\fP\-like sequences.
4780 (PGP only)
4781
4782
4783 .TP
4784 .B pgp_list_pubring_command
4785 .nf
4786 Type: string
4787 Default: \(lq\(rq
4788 .fi
4789 .IP
4790 This command is used to list the public key ring's contents. The
4791 output format must be analogous to the one used by
4792
4793 .IP
4794 .EX
4795 gpg \-\-list\-keys \-\-with\-colons \-\-with\-fingerprint
4796
4797 .EE
4798 .IP
4799 This format is also generated by the \fBmutt_pgpring\fP utility which comes
4800 with mutt.
4801 .IP
4802 Note: gpg's \fBfixed\-list\-mode\fP option should not be used. It
4803 produces a different date format which may result in mutt showing
4804 incorrect key generation dates.
4805 .IP
4806 This is a format string, see the $pgp_decode_command command for
4807 possible \fBprintf(3)\fP\-like sequences.
4808 Note that in this case, %r expands to the search string, which is a list of
4809 one or more quoted values such as email address, name, or keyid.
4810 (PGP only)
4811
4812
4813 .TP
4814 .B pgp_list_secring_command
4815 .nf
4816 Type: string
4817 Default: \(lq\(rq
4818 .fi
4819 .IP
4820 This command is used to list the secret key ring's contents. The
4821 output format must be analogous to the one used by:
4822
4823 .IP
4824 .EX
4825 gpg \-\-list\-keys \-\-with\-colons \-\-with\-fingerprint
4826
4827 .EE
4828 .IP
4829 This format is also generated by the \fBmutt_pgpring\fP utility which comes
4830 with mutt.
4831 .IP
4832 Note: gpg's \fBfixed\-list\-mode\fP option should not be used. It
4833 produces a different date format which may result in mutt showing
4834 incorrect key generation dates.
4835 .IP
4836 This is a format string, see the $pgp_decode_command command for
4837 possible \fBprintf(3)\fP\-like sequences.
4838 Note that in this case, %r expands to the search string, which is a list of
4839 one or more quoted values such as email address, name, or keyid.
4840 (PGP only)
4841
4842
4843 .TP
4844 .B pgp_long_ids
4845 .nf
4846 Type: boolean
4847 Default: yes
4848 .fi
4849 .IP
4850 If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs.
4851 NOTE: Internally, Mutt has transitioned to using fingerprints (or long key IDs
4852 as a fallback). This option now only controls the display of key IDs
4853 in the key selection menu and a few other places.
4854 (PGP only)
4855
4856
4857 .TP
4858 .B pgp_mime_auto
4859 .nf
4860 Type: quadoption
4861 Default: ask\-yes
4862 .fi
4863 .IP
4864 This option controls whether Mutt will prompt you for
4865 automatically sending a (signed/encrypted) message using
4866 PGP/MIME when inline (traditional) fails (for any reason).
4867 .IP
4868 Also note that using the old\-style PGP message format is \fBstrongly\fP
4869 \fBdeprecated\fP.
4870 (PGP only)
4871
4872
4873 .TP
4874 .B pgp_replyinline
4875 .nf
4876 Type: boolean
4877 Default: no
4878 .fi
4879 .IP
4880 Setting this variable will cause Mutt to always attempt to
4881 create an inline (traditional) message when replying to a
4882 message which is PGP encrypted/signed inline. This can be
4883 overridden by use of the pgp menu, when inline is not
4884 required. This option does not automatically detect if the
4885 (replied\-to) message is inline; instead it relies on Mutt
4886 internals for previously checked/flagged messages.
4887 .IP
4888 Note that Mutt might automatically use PGP/MIME for messages
4889 which consist of more than a single MIME part. Mutt can be
4890 configured to ask before sending PGP/MIME messages when inline
4891 (traditional) would not work.
4892 .IP
4893 Also see the $pgp_mime_auto variable.
4894 .IP
4895 Also note that using the old\-style PGP message format is \fBstrongly\fP
4896 \fBdeprecated\fP.
4897 (PGP only)
4898
4899
4900 .TP
4901 .B pgp_retainable_sigs
4902 .nf
4903 Type: boolean
4904 Default: no
4905 .fi
4906 .IP
4907 If \fIset\fP, signed and encrypted messages will consist of nested
4908 \fBmultipart/signed\fP and \fBmultipart/encrypted\fP body parts.
4909 .IP
4910 This is useful for applications like encrypted and signed mailing
4911 lists, where the outer layer (\fBmultipart/encrypted\fP) can be easily
4912 removed, while the inner \fBmultipart/signed\fP part is retained.
4913 (PGP only)
4914
4915
4916 .TP
4917 .B pgp_self_encrypt
4918 .nf
4919 Type: boolean
4920 Default: yes
4921 .fi
4922 .IP
4923 When \fIset\fP, PGP encrypted messages will also be encrypted
4924 using the key in $pgp_default_key.
4925 (PGP only)
4926
4927
4928 .TP
4929 .B pgp_show_unusable
4930 .nf
4931 Type: boolean
4932 Default: yes
4933 .fi
4934 .IP
4935 If \fIset\fP, mutt will display non\-usable keys on the PGP key selection
4936 menu. This includes keys which have been revoked, have expired, or
4937 have been marked as \(lqdisabled\(rq by the user.
4938 (PGP only)
4939
4940
4941 .TP
4942 .B pgp_sign_as
4943 .nf
4944 Type: string
4945 Default: \(lq\(rq
4946 .fi
4947 .IP
4948 If you have a different key pair to use for signing, you should
4949 set this to the signing key. Most people will only need to set
4950 $pgp_default_key. It is recommended that you use the keyid form
4951 to specify your key (e.g. \fB0x00112233\fP).
4952 (PGP only)
4953
4954
4955 .TP
4956 .B pgp_sign_command
4957 .nf
4958 Type: string
4959 Default: \(lq\(rq
4960 .fi
4961 .IP
4962 This command is used to create the detached PGP signature for a
4963 \fBmultipart/signed\fP PGP/MIME body part.
4964 .IP
4965 This is a format string, see the $pgp_decode_command command for
4966 possible \fBprintf(3)\fP\-like sequences.
4967 (PGP only)
4968
4969
4970 .TP
4971 .B pgp_sort_keys
4972 .nf
4973 Type: sort order
4974 Default: address
4975 .fi
4976 .IP
4977 Specifies how the entries in the pgp menu are sorted. The
4978 following are legal values:
4979 .RS
4980 .PD 0
4981 .TP
4982 address
4983 sort alphabetically by user id
4984 .TP
4985 keyid
4986 sort alphabetically by key id
4987 .TP
4988 date
4989 sort by key creation date
4990 .TP
4991 trust
4992 sort by the trust of the key
4993 .RE
4994 .PD 1
4995 .IP
4996 If you prefer reverse order of the above values, prefix it with
4997 \(lqreverse\-\(rq.
4998 (PGP only)
4999
5000
5001 .TP
5002 .B pgp_strict_enc
5003 .nf
5004 Type: boolean
5005 Default: yes
5006 .fi
5007 .IP
5008 If \fIset\fP, Mutt will automatically encode PGP/MIME signed messages as
5009 quoted\-printable. Please note that unsetting this variable may
5010 lead to problems with non\-verifyable PGP signatures, so only change
5011 this if you know what you are doing.
5012 (PGP only)
5013
5014
5015 .TP
5016 .B pgp_timeout
5017 .nf
5018 Type: number (long)
5019 Default: 300
5020 .fi
5021 .IP
5022 The number of seconds after which a cached passphrase will expire if
5023 not used.
5024 (PGP only)
5025
5026
5027 .TP
5028 .B pgp_use_gpg_agent
5029 .nf
5030 Type: boolean
5031 Default: yes
5032 .fi
5033 .IP
5034 If \fIset\fP, mutt expects a \fBgpg\-agent(1)\fP process will handle
5035 private key passphrase prompts. If \fIunset\fP, mutt will prompt
5036 for the passphrase and pass it via stdin to the pgp command.
5037 .IP
5038 Note that as of version 2.1, GnuPG automatically spawns an agent
5039 and requires the agent be used for passphrase management. Since
5040 that version is increasingly prevalent, this variable now
5041 defaults \fIset\fP.
5042 .IP
5043 Mutt works with a GUI or curses pinentry program. A TTY pinentry
5044 should not be used.
5045 .IP
5046 If you are using an older version of GnuPG without an agent running,
5047 or another encryption program without an agent, you will need to
5048 \fIunset\fP this variable.
5049 (PGP only)
5050
5051
5052 .TP
5053 .B pgp_verify_command
5054 .nf
5055 Type: string
5056 Default: \(lq\(rq
5057 .fi
5058 .IP
5059 This command is used to verify PGP signatures.
5060 .IP
5061 This is a format string, see the $pgp_decode_command command for
5062 possible \fBprintf(3)\fP\-like sequences.
5063 (PGP only)
5064
5065
5066 .TP
5067 .B pgp_verify_key_command
5068 .nf
5069 Type: string
5070 Default: \(lq\(rq
5071 .fi
5072 .IP
5073 This command is used to verify key information from the key selection
5074 menu.
5075 .IP
5076 This is a format string, see the $pgp_decode_command command for
5077 possible \fBprintf(3)\fP\-like sequences.
5078 (PGP only)
5079
5080
5081 .TP
5082 .B pipe_decode
5083 .nf
5084 Type: boolean
5085 Default: no
5086 .fi
5087 .IP
5088 Used in connection with the \fB<pipe\-message>\fP function. When \fIunset\fP,
5089 Mutt will pipe the messages without any preprocessing. When \fIset\fP, Mutt
5090 will attempt to decode the messages first.
5091 .IP
5092 Also see $pipe_decode_weed, which controls whether headers will
5093 be weeded when this is \fIset\fP.
5094
5095
5096 .TP
5097 .B pipe_decode_weed
5098 .nf
5099 Type: boolean
5100 Default: yes
5101 .fi
5102 .IP
5103 For \fB<pipe\-message>\fP, when $pipe_decode is set, this further
5104 controls whether Mutt will weed headers.
5105
5106
5107 .TP
5108 .B pipe_sep
5109 .nf
5110 Type: string
5111 Default: \(lq\\n\(rq
5112 .fi
5113 .IP
5114 The separator to add between messages when piping a list of tagged
5115 messages to an external Unix command.
5116
5117
5118 .TP
5119 .B pipe_split
5120 .nf
5121 Type: boolean
5122 Default: no
5123 .fi
5124 .IP
5125 Used in connection with the \fB<pipe\-message>\fP function following
5126 \fB<tag\-prefix>\fP. If this variable is \fIunset\fP, when piping a list of
5127 tagged messages Mutt will concatenate the messages and will pipe them
5128 all concatenated. When \fIset\fP, Mutt will pipe the messages one by one.
5129 In both cases the messages are piped in the current sorted order,
5130 and the $pipe_sep separator is added after each message.
5131
5132
5133 .TP
5134 .B pop_auth_try_all
5135 .nf
5136 Type: boolean
5137 Default: yes
5138 .fi
5139 .IP
5140 If \fIset\fP, Mutt will try all available authentication methods.
5141 When \fIunset\fP, Mutt will only fall back to other authentication
5142 methods if the previous methods are unavailable. If a method is
5143 available but authentication fails, Mutt will not connect to the POP server.
5144
5145
5146 .TP
5147 .B pop_authenticators
5148 .nf
5149 Type: string
5150 Default: \(lq\(rq
5151 .fi
5152 .IP
5153 This is a colon\-delimited list of authentication methods mutt may
5154 attempt to use to log in to an POP server, in the order mutt should
5155 try them. Authentication methods are either \(lquser\(rq, \(lqapop\(rq or any
5156 SASL mechanism, e.g. \(lqdigest\-md5\(rq, \(lqgssapi\(rq or \(lqcram\-md5\(rq.
5157 This option is case\-insensitive. If this option is \fIunset\fP
5158 (the default) mutt will try all available methods, in order from
5159 most\-secure to least\-secure.
5160 .IP
5161 Example:
5162
5163 .IP
5164 .EX
5165 set pop_authenticators=\(rqdigest\-md5:apop:user\(rq
5166
5167 .EE
5168
5169
5170 .TP
5171 .B pop_checkinterval
5172 .nf
5173 Type: number
5174 Default: 60
5175 .fi
5176 .IP
5177 This variable configures how often (in seconds) mutt should look for
5178 new mail in the currently selected mailbox if it is a POP mailbox.
5179
5180
5181 .TP
5182 .B pop_delete
5183 .nf
5184 Type: quadoption
5185 Default: ask\-no
5186 .fi
5187 .IP
5188 If \fIset\fP, Mutt will delete successfully downloaded messages from the POP
5189 server when using the \fB<fetch-mail>\fP function. When \fIunset\fP, Mutt will
5190 download messages but also leave them on the POP server.
5191
5192
5193 .TP
5194 .B pop_host
5195 .nf
5196 Type: string
5197 Default: \(lq\(rq
5198 .fi
5199 .IP
5200 The name of your POP server for the \fB<fetch-mail>\fP function. You
5201 can also specify an alternative port, username and password, i.e.:
5202
5203 .IP
5204 .EX
5205 [pop[s]://][username[:password]@]popserver[:port]
5206
5207 .EE
5208 .IP
5209 where \(lq[...]\(rq denotes an optional part.
5210
5211
5212 .TP
5213 .B pop_last
5214 .nf
5215 Type: boolean
5216 Default: no
5217 .fi
5218 .IP
5219 If this variable is \fIset\fP, mutt will try to use the \(lq\fBLAST\fP\(rq POP command
5220 for retrieving only unread messages from the POP server when using
5221 the \fB<fetch-mail>\fP function.
5222
5223
5224 .TP
5225 .B pop_oauth_refresh_command
5226 .nf
5227 Type: string
5228 Default: \(lq\(rq
5229 .fi
5230 .IP
5231 The command to run to generate an OAUTH refresh token for
5232 authorizing your connection to your POP server. This command will be
5233 run on every connection attempt that uses the OAUTHBEARER authentication
5234 mechanism. See \(lqoauth\(rq for details.
5235
5236
5237 .TP
5238 .B pop_pass
5239 .nf
5240 Type: string
5241 Default: \(lq\(rq
5242 .fi
5243 .IP
5244 Specifies the password for your POP account. If \fIunset\fP, Mutt will
5245 prompt you for your password when you open a POP mailbox.
5246 .IP
5247 \fBWarning\fP: you should only use this option when you are on a
5248 fairly secure machine, because the superuser can read your muttrc
5249 even if you are the only one who can read the file.
5250
5251
5252 .TP
5253 .B pop_reconnect
5254 .nf
5255 Type: quadoption
5256 Default: ask\-yes
5257 .fi
5258 .IP
5259 Controls whether or not Mutt will try to reconnect to the POP server if
5260 the connection is lost.
5261
5262
5263 .TP
5264 .B pop_user
5265 .nf
5266 Type: string
5267 Default: \(lq\(rq
5268 .fi
5269 .IP
5270 Your login name on the POP server.
5271 .IP
5272 This variable defaults to your user name on the local machine.
5273
5274
5275 .TP
5276 .B post_indent_string
5277 .nf
5278 Type: string
5279 Default: \(lq\(rq
5280 .fi
5281 .IP
5282 Similar to the $attribution variable, Mutt will append this
5283 string after the inclusion of a message which is being replied to.
5284 For a full listing of defined \fBprintf(3)\fP\-like sequences see
5285 the section on $index_format.
5286
5287
5288 .TP
5289 .B postpone
5290 .nf
5291 Type: quadoption
5292 Default: ask\-yes
5293 .fi
5294 .IP
5295 Controls whether or not messages are saved in the $postponed
5296 mailbox when you elect not to send immediately.
5297 .IP
5298 Also see the $recall variable.
5299
5300
5301 .TP
5302 .B postponed
5303 .nf
5304 Type: path
5305 Default: \(lq~/postponed\(rq
5306 .fi
5307 .IP
5308 Mutt allows you to indefinitely \(lqpostpone sending a message\(rq which
5309 you are editing. When you choose to postpone a message, Mutt saves it
5310 in the mailbox specified by this variable.
5311 .IP
5312 Also see the $postpone variable.
5313
5314
5315 .TP
5316 .B postpone_encrypt
5317 .nf
5318 Type: boolean
5319 Default: no
5320 .fi
5321 .IP
5322 When \fIset\fP, postponed messages that are marked for encryption will be
5323 self\-encrypted. Mutt will first try to encrypt using the value specified
5324 in $pgp_default_key or $smime_default_key. If those are not
5325 set, it will try the deprecated $postpone_encrypt_as.
5326 (Crypto only)
5327
5328
5329 .TP
5330 .B postpone_encrypt_as
5331 .nf
5332 Type: string
5333 Default: \(lq\(rq
5334 .fi
5335 .IP
5336 This is a deprecated fall\-back variable for $postpone_encrypt.
5337 Please use $pgp_default_key or $smime_default_key.
5338 (Crypto only)
5339
5340
5341 .TP
5342 .B preconnect
5343 .nf
5344 Type: string
5345 Default: \(lq\(rq
5346 .fi
5347 .IP
5348 If \fIset\fP, a shell command to be executed if mutt fails to establish
5349 a connection to the server. This is useful for setting up secure
5350 connections, e.g. with \fBssh(1)\fP. If the command returns a nonzero
5351 status, mutt gives up opening the server. Example:
5352
5353 .IP
5354 .EX
5355 set preconnect=\(rqssh \-f \-q \-L 1234:mailhost.net:143 mailhost.net \\
5356 sleep 20 < /dev/null > /dev/null\(rq
5357
5358 .EE
5359 .IP
5360 Mailbox \(lqfoo\(rq on \(lqmailhost.net\(rq can now be reached
5361 as \(lq{localhost:1234}foo\(rq.
5362 .IP
5363 Note: For this example to work, you must be able to log in to the
5364 remote machine without having to enter a password.
5365
5366
5367 .TP
5368 .B print
5369 .nf
5370 Type: quadoption
5371 Default: ask\-no
5372 .fi
5373 .IP
5374 Controls whether or not Mutt really prints messages.
5375 This is set to \(lqask\-no\(rq by default, because some people
5376 accidentally hit \(lqp\(rq often.
5377
5378
5379 .TP
5380 .B print_command
5381 .nf
5382 Type: path
5383 Default: \(lqlpr\(rq
5384 .fi
5385 .IP
5386 This specifies the command pipe that should be used to print messages.
5387
5388
5389 .TP
5390 .B print_decode
5391 .nf
5392 Type: boolean
5393 Default: yes
5394 .fi
5395 .IP
5396 Used in connection with the \fB<print\-message>\fP function. If this
5397 option is \fIset\fP, the message is decoded before it is passed to the
5398 external command specified by $print_command. If this option
5399 is \fIunset\fP, no processing will be applied to the message when
5400 printing it. The latter setting may be useful if you are using
5401 some advanced printer filter which is able to properly format
5402 e\-mail messages for printing.
5403 .IP
5404 Also see $print_decode_weed, which controls whether headers will
5405 be weeded when this is \fIset\fP.
5406
5407
5408 .TP
5409 .B print_decode_weed
5410 .nf
5411 Type: boolean
5412 Default: yes
5413 .fi
5414 .IP
5415 For \fB<print\-message>\fP, when $print_decode is set, this
5416 further controls whether Mutt will weed headers.
5417
5418
5419 .TP
5420 .B print_split
5421 .nf
5422 Type: boolean
5423 Default: no
5424 .fi
5425 .IP
5426 Used in connection with the \fB<print\-message>\fP function. If this option
5427 is \fIset\fP, the command specified by $print_command is executed once for
5428 each message which is to be printed. If this option is \fIunset\fP,
5429 the command specified by $print_command is executed only once, and
5430 all the messages are concatenated, with a form feed as the message
5431 separator.
5432 .IP
5433 Those who use the \fBenscript\fP(1) program's mail\-printing mode will
5434 most likely want to \fIset\fP this option.
5435
5436
5437 .TP
5438 .B prompt_after
5439 .nf
5440 Type: boolean
5441 Default: yes
5442 .fi
5443 .IP
5444 If you use an \fIexternal\fP $pager, setting this variable will
5445 cause Mutt to prompt you for a command when the pager exits rather
5446 than returning to the index menu. If \fIunset\fP, Mutt will return to the
5447 index menu when the external pager exits.
5448
5449
5450 .TP
5451 .B query_command
5452 .nf
5453 Type: path
5454 Default: \(lq\(rq
5455 .fi
5456 .IP
5457 This specifies the command Mutt will use to make external address
5458 queries. The string may contain a \(lq%s\(rq, which will be substituted
5459 with the query string the user types. Mutt will add quotes around the
5460 string substituted for \(lq%s\(rq automatically according to shell quoting
5461 rules, so you should avoid adding your own. If no \(lq%s\(rq is found in
5462 the string, Mutt will append the user's query to the end of the string.
5463 See \(lqquery\(rq for more information.
5464
5465
5466 .TP
5467 .B query_format
5468 .nf
5469 Type: string
5470 Default: \(lq%4c %t %\-25.25a %\-25.25n %?e?(%e)?\(rq
5471 .fi
5472 .IP
5473 This variable describes the format of the \(lqquery\(rq menu. The
5474 following \fBprintf(3)\fP\-style sequences are understood:
5475 .RS
5476 .PD 0
5477 .TP
5478 %a
5479 destination address
5480 .TP
5481 %c
5482 current entry number
5483 .TP
5484 %e
5485 extra information *
5486 .TP
5487 %n
5488 destination name
5489 .TP
5490 %t
5491 \(lq*\(rq if current entry is tagged, a space otherwise
5492 .TP
5493 %>X
5494 right justify the rest of the string and pad with \(lqX\(rq
5495 .TP
5496 %|X
5497 pad to the end of the line with \(lqX\(rq
5498 .TP
5499 %*X
5500 soft\-fill with character \(lqX\(rq as pad
5501 .RE
5502 .PD 1
5503 .IP
5504 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
5505 .IP
5506 * = can be optionally printed if nonzero, see the $status_format documentation.
5507
5508
5509 .TP
5510 .B quit
5511 .nf
5512 Type: quadoption
5513 Default: yes
5514 .fi
5515 .IP
5516 This variable controls whether \(lqquit\(rq and \(lqexit\(rq actually quit
5517 from mutt. If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they
5518 have no effect, and if it is set to \fIask\-yes\fP or \fIask\-no\fP, you are
5519 prompted for confirmation when you try to quit.
5520
5521
5522 .TP
5523 .B quote_regexp
5524 .nf
5525 Type: regular expression
5526 Default: \(lq^([ \\t]*[|>:}#])+\(rq
5527 .fi
5528 .IP
5529 A regular expression used in the internal pager to determine quoted
5530 sections of text in the body of a message. Quoted text may be filtered
5531 out using the \fB<toggle\-quoted>\fP command, or colored according to the
5532 \(lqcolor quoted\(rq family of directives.
5533 .IP
5534 Higher levels of quoting may be colored differently (\(lqcolor quoted1\(rq,
5535 \(lqcolor quoted2\(rq, etc.). The quoting level is determined by removing
5536 the last character from the matched text and recursively reapplying
5537 the regular expression until it fails to produce a match.
5538 .IP
5539 Match detection may be overridden by the $smileys regular expression.
5540
5541
5542 .TP
5543 .B read_inc
5544 .nf
5545 Type: number
5546 Default: 10
5547 .fi
5548 .IP
5549 If set to a value greater than 0, Mutt will display which message it
5550 is currently on when reading a mailbox or when performing search actions
5551 such as search and limit. The message is printed after
5552 this many messages have been read or searched (e.g., if set to 25, Mutt will
5553 print a message when it is at message 25, and then again when it gets
5554 to message 50). This variable is meant to indicate progress when
5555 reading or searching large mailboxes which may take some time.
5556 When set to 0, only a single message will appear before the reading
5557 the mailbox.
5558 .IP
5559 Also see the $write_inc, $net_inc and $time_inc variables and the
5560 \(lqtuning\(rq section of the manual for performance considerations.
5561
5562
5563 .TP
5564 .B read_only
5565 .nf
5566 Type: boolean
5567 Default: no
5568 .fi
5569 .IP
5570 If \fIset\fP, all folders are opened in read\-only mode.
5571
5572
5573 .TP
5574 .B realname
5575 .nf
5576 Type: string
5577 Default: \(lq\(rq
5578 .fi
5579 .IP
5580 This variable specifies what \(lqreal\(rq or \(lqpersonal\(rq name should be used
5581 when sending messages.
5582 .IP
5583 By default, this is the GECOS field from \fB/etc/passwd\fP. Note that this
5584 variable will \fInot\fP be used when the user has set a real name
5585 in the $from variable.
5586
5587
5588 .TP
5589 .B recall
5590 .nf
5591 Type: quadoption
5592 Default: ask\-yes
5593 .fi
5594 .IP
5595 Controls whether or not Mutt recalls postponed messages
5596 when composing a new message.
5597 .IP
5598 Setting this variable to \fIyes\fP is not generally useful, and thus not
5599 recommended. Note that the \fB<recall\-message>\fP function can be used
5600 to manually recall postponed messages.
5601 .IP
5602 Also see $postponed variable.
5603
5604
5605 .TP
5606 .B record
5607 .nf
5608 Type: path
5609 Default: \(lq~/sent\(rq
5610 .fi
5611 .IP
5612 This specifies the file into which your outgoing messages should be
5613 appended. (This is meant as the primary method for saving a copy of
5614 your messages, but another way to do this is using the \(lqmy_hdr\(rq
5615 command to create a \(lqBcc:\(rq field with your email address in it.)
5616 .IP
5617 The value of \fI$record\fP is overridden by the $force_name and
5618 $save_name variables, and the \(lqfcc-hook\(rq command. Also see $copy
5619 and $write_bcc.
5620 .IP
5621 Multiple mailboxes may be specified if $fcc_delimiter is
5622 set to a string delimiter.
5623
5624
5625 .TP
5626 .B reflow_space_quotes
5627 .nf
5628 Type: boolean
5629 Default: yes
5630 .fi
5631 .IP
5632 This option controls how quotes from format=flowed messages are displayed
5633 in the pager and when replying (with $text_flowed \fIunset\fP).
5634 When set, this option adds spaces after each level of quote marks, turning
5635 \(rq>>>foo\(rq into \(rq> > > foo\(rq.
5636 .IP
5637 \fBNote:\fP If $reflow_text is \fIunset\fP, this option has no effect.
5638 Also, this option does not affect replies when $text_flowed is \fIset\fP.
5639
5640
5641 .TP
5642 .B reflow_text
5643 .nf
5644 Type: boolean
5645 Default: yes
5646 .fi
5647 .IP
5648 When \fIset\fP, Mutt will reformat paragraphs in text/plain
5649 parts marked format=flowed. If \fIunset\fP, Mutt will display paragraphs
5650 unaltered from how they appear in the message body. See RFC3676 for
5651 details on the \fIformat=flowed\fP format.
5652 .IP
5653 Also see $reflow_wrap, and $wrap.
5654
5655
5656 .TP
5657 .B reflow_wrap
5658 .nf
5659 Type: number
5660 Default: 78
5661 .fi
5662 .IP
5663 This variable controls the maximum paragraph width when reformatting text/plain
5664 parts when $reflow_text is \fIset\fP. When the value is 0, paragraphs will
5665 be wrapped at the terminal's right margin. A positive value sets the
5666 paragraph width relative to the left margin. A negative value set the
5667 paragraph width relative to the right margin.
5668 .IP
5669 Also see $wrap.
5670
5671
5672 .TP
5673 .B reply_regexp
5674 .nf
5675 Type: regular expression (localized)
5676 Default: \(lq^(re)(\\[[0\-9]+\\])*:[ \\t]*\(rq
5677 .fi
5678 .IP
5679 A regular expression used to recognize reply messages when
5680 threading and replying. The default value corresponds to the
5681 standard Latin \(rqRe:\(rq prefix.
5682 .IP
5683 This value may have been localized by the translator for your
5684 locale, adding other prefixes that are common in the locale. You
5685 can add your own prefixes by appending inside \fB\(rq^(re)\(rq\fP. For
5686 example: \fB\(rq^(re|se)\(rq\fP or \fB\(rq^(re|aw|se)\(rq\fP.
5687 .IP
5688 The second parenthesized expression matches zero or more
5689 bracketed numbers following the prefix, such as \fB\(rqRe[1]: \(rq\fP.
5690 The initial \fB\(rq\\\\[\(rq\fP means a literal left\-bracket character.
5691 Note the backslash must be doubled when used inside a double
5692 quoted string in the muttrc. \fB\(rq[0\-9]+\(rq\fP means one or more
5693 numbers. \fB\(rq\\\\]\(rq\fP means a literal right\-bracket. Finally the
5694 whole parenthesized expression has a \fB\(rq*\(rq\fP suffix, meaning it
5695 can occur zero or more times.
5696 .IP
5697 The last part matches a colon followed by an optional space or
5698 tab. Note \fB\(rq\\t\(rq\fP is converted to a literal tab inside a
5699 double quoted string. If you use a single quoted string, you
5700 would have to type an actual tab character, and would need to
5701 convert the double\-backslashes to single backslashes.
5702 .IP
5703 Note: the result of this regexp match against the subject is
5704 stored in the header cache. Mutt isn't smart enough to
5705 invalidate a header cache entry based on changing $reply_regexp,
5706 so if you aren't seeing correct values in the index, try
5707 temporarily turning off the header cache. If that fixes the
5708 problem, then once the variable is set to your liking, remove
5709 your stale header cache files and turn the header cache back on.
5710
5711
5712 .TP
5713 .B reply_self
5714 .nf
5715 Type: boolean
5716 Default: no
5717 .fi
5718 .IP
5719 If \fIunset\fP and you are replying to a message sent by you, Mutt will
5720 assume that you want to reply to the recipients of that message rather
5721 than to yourself.
5722 .IP
5723 Also see the \(lqalternates\(rq command.
5724
5725
5726 .TP
5727 .B reply_to
5728 .nf
5729 Type: quadoption
5730 Default: ask\-yes
5731 .fi
5732 .IP
5733 If \fIset\fP, when replying to a message, Mutt will use the address listed
5734 in the Reply\-to: header as the recipient of the reply. If \fIunset\fP,
5735 it will use the address in the From: header field instead. This
5736 option is useful for reading a mailing list that sets the Reply\-To:
5737 header field to the list address and you want to send a private
5738 message to the author of a message.
5739
5740
5741 .TP
5742 .B resolve
5743 .nf
5744 Type: boolean
5745 Default: yes
5746 .fi
5747 .IP
5748 When \fIset\fP, the cursor will be automatically advanced to the next
5749 (possibly undeleted) message whenever a command that modifies the
5750 current message is executed.
5751
5752
5753 .TP
5754 .B resume_draft_files
5755 .nf
5756 Type: boolean
5757 Default: no
5758 .fi
5759 .IP
5760 If \fIset\fP, draft files (specified by \fB\-H\fP on the command
5761 line) are processed similarly to when resuming a postponed
5762 message. Recipients are not prompted for; send\-hooks are not
5763 evaluated; no alias expansion takes place; user\-defined headers
5764 and signatures are not added to the message.
5765
5766
5767 .TP
5768 .B resume_edited_draft_files
5769 .nf
5770 Type: boolean
5771 Default: yes
5772 .fi
5773 .IP
5774 If \fIset\fP, draft files previously edited (via \fB\-E \-H\fP on
5775 the command line) will have $resume_draft_files automatically
5776 set when they are used as a draft file again.
5777 .IP
5778 The first time a draft file is saved, mutt will add a header,
5779 X\-Mutt\-Resume\-Draft to the saved file. The next time the draft
5780 file is read in, if mutt sees the header, it will set
5781 $resume_draft_files.
5782 .IP
5783 This option is designed to prevent multiple signatures,
5784 user\-defined headers, and other processing effects from being
5785 made multiple times to the draft file.
5786
5787
5788 .TP
5789 .B reverse_alias
5790 .nf
5791 Type: boolean
5792 Default: no
5793 .fi
5794 .IP
5795 This variable controls whether or not Mutt will display the \(lqpersonal\(rq
5796 name from your aliases in the index menu if it finds an alias that
5797 matches the message's sender. For example, if you have the following
5798 alias:
5799
5800 .IP
5801 .EX
5802 alias juser [email protected] (Joe User)
5803
5804 .EE
5805 .IP
5806 and then you receive mail which contains the following header:
5807
5808 .IP
5809 .EX
5810 From: [email protected]
5811
5812 .EE
5813 .IP
5814 It would be displayed in the index menu as \(lqJoe User\(rq instead of
5815 \([email protected].\(rq This is useful when the person's e\-mail
5816 address is not human friendly.
5817
5818
5819 .TP
5820 .B reverse_name
5821 .nf
5822 Type: boolean
5823 Default: no
5824 .fi
5825 .IP
5826 It may sometimes arrive that you receive mail to a certain machine,
5827 move the messages to another machine, and reply to some the messages
5828 from there. If this variable is \fIset\fP, the default \fIFrom:\fP line of
5829 the reply messages is built using the address where you received the
5830 messages you are replying to \fBif\fP that address matches your
5831 \(lqalternates\(rq. If the variable is \fIunset\fP, or the address that would be
5832 used doesn't match your \(lqalternates\(rq, the \fIFrom:\fP line will use
5833 your address on the current machine.
5834 .IP
5835 Also see the \(lqalternates\(rq command and $reverse_realname.
5836
5837
5838 .TP
5839 .B reverse_realname
5840 .nf
5841 Type: boolean
5842 Default: yes
5843 .fi
5844 .IP
5845 This variable fine\-tunes the behavior of the $reverse_name feature.
5846 .IP
5847 When it is \fIunset\fP, Mutt will remove the real name part of a
5848 matching address. This allows the use of the email address
5849 without having to also use what the sender put in the real name
5850 field.
5851 .IP
5852 When it is \fIset\fP, Mutt will use the matching address as\-is.
5853 .IP
5854 In either case, a missing real name will be filled in afterwards
5855 using the value of $realname.
5856
5857
5858 .TP
5859 .B rfc2047_parameters
5860 .nf
5861 Type: boolean
5862 Default: yes
5863 .fi
5864 .IP
5865 When this variable is \fIset\fP, Mutt will decode RFC2047\-encoded MIME
5866 parameters. You want to set this variable when mutt suggests you
5867 to save attachments to files named like:
5868
5869 .IP
5870 .EX
5871 =?iso\-8859\-1?Q?file=5F=E4=5F991116=2Ezip?=
5872
5873 .EE
5874 .IP
5875 When this variable is \fIset\fP interactively, the change won't be
5876 active until you change folders.
5877 .IP
5878 Note that this use of RFC2047's encoding is explicitly
5879 prohibited by the standard, but nevertheless encountered in the
5880 wild.
5881 .IP
5882 Also note that setting this parameter will \fInot\fP have the effect
5883 that mutt \fIgenerates\fP this kind of encoding. Instead, mutt will
5884 unconditionally use the encoding specified in RFC2231.
5885
5886
5887 .TP
5888 .B save_address
5889 .nf
5890 Type: boolean
5891 Default: no
5892 .fi
5893 .IP
5894 If \fIset\fP, mutt will take the sender's full address when choosing a
5895 default folder for saving a mail. If $save_name or $force_name
5896 is \fIset\fP too, the selection of the Fcc folder will be changed as well.
5897
5898
5899 .TP
5900 .B save_empty
5901 .nf
5902 Type: boolean
5903 Default: yes
5904 .fi
5905 .IP
5906 When \fIunset\fP, mailboxes which contain no saved messages will be removed
5907 when closed (the exception is $spoolfile which is never removed).
5908 If \fIset\fP, mailboxes are never removed.
5909 .IP
5910 \fBNote:\fP This only applies to mbox and MMDF folders, Mutt does not
5911 delete MH and Maildir directories.
5912
5913
5914 .TP
5915 .B save_history
5916 .nf
5917 Type: number
5918 Default: 0
5919 .fi
5920 .IP
5921 This variable controls the size of the history (per category) saved in the
5922 $history_file file.
5923
5924
5925 .TP
5926 .B save_name
5927 .nf
5928 Type: boolean
5929 Default: no
5930 .fi
5931 .IP
5932 This variable controls how copies of outgoing messages are saved.
5933 When \fIset\fP, a check is made to see if a mailbox specified by the
5934 recipient address exists (this is done by searching for a mailbox in
5935 the $folder directory with the \fIusername\fP part of the
5936 recipient address). If the mailbox exists, the outgoing message will
5937 be saved to that mailbox, otherwise the message is saved to the
5938 $record mailbox.
5939 .IP
5940 Also see the $force_name variable.
5941
5942
5943 .TP
5944 .B score
5945 .nf
5946 Type: boolean
5947 Default: yes
5948 .fi
5949 .IP
5950 When this variable is \fIunset\fP, scoring is turned off. This can
5951 be useful to selectively disable scoring for certain folders when the
5952 $score_threshold_delete variable and related are used.
5953
5954
5955 .TP
5956 .B score_threshold_delete
5957 .nf
5958 Type: number
5959 Default: \-1
5960 .fi
5961 .IP
5962 Messages which have been assigned a score equal to or lower than the value
5963 of this variable are automatically marked for deletion by mutt. Since
5964 mutt scores are always greater than or equal to zero, the default setting
5965 of this variable will never mark a message for deletion.
5966
5967
5968 .TP
5969 .B score_threshold_flag
5970 .nf
5971 Type: number
5972 Default: 9999
5973 .fi
5974 .IP
5975 Messages which have been assigned a score greater than or equal to this
5976 variable's value are automatically marked \(rqflagged\(rq.
5977
5978
5979 .TP
5980 .B score_threshold_read
5981 .nf
5982 Type: number
5983 Default: \-1
5984 .fi
5985 .IP
5986 Messages which have been assigned a score equal to or lower than the value
5987 of this variable are automatically marked as read by mutt. Since
5988 mutt scores are always greater than or equal to zero, the default setting
5989 of this variable will never mark a message read.
5990
5991
5992 .TP
5993 .B search_context
5994 .nf
5995 Type: number
5996 Default: 0
5997 .fi
5998 .IP
5999 For the pager, this variable specifies the number of lines shown
6000 before search results. By default, search results will be top\-aligned.
6001
6002
6003 .TP
6004 .B send_charset
6005 .nf
6006 Type: string
6007 Default: \(lqiso\-8859\-1:iso\-8859\-2:iso\-8859\-7:iso\-8859\-9:koi8\-r:iso\-2022\-jp:euc\-kr:gb2312:big5:utf\-8\(rq
6008 .fi
6009 .IP
6010 A colon\-delimited list of character sets for outgoing messages. Mutt will use the
6011 first character set into which the text can be converted exactly.
6012 If your $charset is not \(lqiso\-8859\-1\(rq and recipients may not
6013 understand \(lqUTF\-8\(rq, it is advisable to include in the list an
6014 appropriate widely used standard character set (such as
6015 \(lqiso\-8859\-2\(rq, \(lqkoi8\-r\(rq or \(lqiso\-2022\-jp\(rq) either instead of or after
6016 \(lqiso\-8859\-1\(rq.
6017 .IP
6018 In case the text cannot be converted into one of these exactly,
6019 mutt uses $charset as a fallback.
6020
6021
6022 .TP
6023 .B send_multipart_alternative
6024 .nf
6025 Type: quadoption
6026 Default: no
6027 .fi
6028 .IP
6029 If \fIset\fP, Mutt will generate a multipart/alternative
6030 container and an alternative part using the filter script specified in
6031 $send_multipart_alternative_filter.
6032 See the section \(lqMIME Multipart/Alternative\(rq (alternative-order).
6033 .IP
6034 Note that enabling multipart/alternative is not compatible with inline
6035 PGP encryption. Mutt will prompt to use PGP/MIME in that case.
6036
6037
6038 .TP
6039 .B send_multipart_alternative_filter
6040 .nf
6041 Type: path
6042 Default: \(lq\(rq
6043 .fi
6044 .IP
6045 This specifies a filter script, which will convert the main
6046 (composed) message of the email to an alternative format. The
6047 message will be piped to the filter's stdin. The expected output
6048 of the filter is the generated mime type, e.g. text/html,
6049 followed by a blank line, and then the converted content.
6050 See the section \(lqMIME Multipart/Alternative\(rq (alternative-order).
6051
6052
6053 .TP
6054 .B sendmail
6055 .nf
6056 Type: path
6057 Default: \(lq/usr/sbin/sendmail \-oem \-oi\(rq
6058 .fi
6059 .IP
6060 Specifies the program and arguments used to deliver mail sent by Mutt.
6061 Mutt expects that the specified program interprets additional
6062 arguments as recipient addresses. Mutt appends all recipients after
6063 adding a \fB\-\-\fP delimiter (if not already present). Additional
6064 flags, such as for $use_8bitmime, $use_envelope_from,
6065 $dsn_notify, or $dsn_return will be added before the delimiter.
6066 .IP
6067 \fBNote:\fP This command is invoked differently from most other
6068 commands in Mutt. It is tokenized by space, and invoked directly
6069 via \fBexecvp(3)\fP with an array of arguments \- so commands or
6070 arguments with spaces in them are not supported. The shell is
6071 not used to run the command, so shell quoting is also not
6072 supported.
6073 .IP
6074 \fBSee also:\fP $write_bcc.
6075
6076
6077 .TP
6078 .B sendmail_wait
6079 .nf
6080 Type: number
6081 Default: 0
6082 .fi
6083 .IP
6084 Specifies the number of seconds to wait for the $sendmail process
6085 to finish before giving up and putting delivery in the background.
6086 .IP
6087 Mutt interprets the value of this variable as follows:
6088 .RS
6089 .PD 0
6090 .TP
6091 >0
6092 number of seconds to wait for sendmail to finish before continuing
6093 .TP
6094 0
6095 wait forever for sendmail to finish
6096 .TP
6097 <0
6098 always put sendmail in the background without waiting
6099 .RE
6100 .PD 1
6101 .IP
6102 Note that if you specify a value other than 0, the output of the child
6103 process will be put in a temporary file. If there is some error, you
6104 will be informed as to where to find the output.
6105
6106
6107 .TP
6108 .B shell
6109 .nf
6110 Type: path
6111 Default: \(lq\(rq
6112 .fi
6113 .IP
6114 Command to use when spawning a subshell. By default, the user's login
6115 shell from \fB/etc/passwd\fP is used.
6116
6117
6118 .TP
6119 .B sidebar_delim_chars
6120 .nf
6121 Type: string
6122 Default: \(lq/.\(rq
6123 .fi
6124 .IP
6125 This contains the list of characters which you would like to treat
6126 as folder separators for displaying paths in the sidebar.
6127 .IP
6128 Local mail is often arranged in directories: `dir1/dir2/mailbox'.
6129
6130 .IP
6131 .EX
6132 set sidebar_delim_chars='/'
6133
6134 .EE
6135 .IP
6136 IMAP mailboxes are often named: `folder1.folder2.mailbox'.
6137
6138 .IP
6139 .EX
6140 set sidebar_delim_chars='.'
6141
6142 .EE
6143 .IP
6144 \fBSee also:\fP $sidebar_short_path, $sidebar_folder_indent, $sidebar_indent_string.
6145
6146
6147 .TP
6148 .B sidebar_divider_char
6149 .nf
6150 Type: string
6151 Default: \(lq|\(rq
6152 .fi
6153 .IP
6154 This specifies the characters to be drawn between the sidebar (when
6155 visible) and the other Mutt panels. ASCII and Unicode line\-drawing
6156 characters are supported.
6157
6158
6159 .TP
6160 .B sidebar_folder_indent
6161 .nf
6162 Type: boolean
6163 Default: no
6164 .fi
6165 .IP
6166 Set this to indent mailboxes in the sidebar.
6167 .IP
6168 \fBSee also:\fP $sidebar_short_path, $sidebar_indent_string, $sidebar_delim_chars.
6169
6170
6171 .TP
6172 .B sidebar_format
6173 .nf
6174 Type: string
6175 Default: \(lq%B%* %n\(rq
6176 .fi
6177 .IP
6178 This variable allows you to customize the sidebar display. This string is
6179 similar to $index_format, but has its own set of \fBprintf(3)\fP\-like
6180 sequences:
6181 .RS
6182 .PD 0
6183 .TP
6184 %B
6185 Name of the mailbox
6186 .TP
6187 %S
6188 * Size of mailbox (total number of messages)
6189 .TP
6190 %N
6191 * Number of unread messages in the mailbox
6192 .TP
6193 %n
6194 N if mailbox has new mail, blank otherwise
6195 .TP
6196 %F
6197 * Number of Flagged messages in the mailbox
6198 .TP
6199 %!
6200 \(lq!\(rq : one flagged message;
6201 \(lq!!\(rq : two flagged messages;
6202 \(lqn!\(rq : n flagged messages (for n > 2).
6203 Otherwise prints nothing.
6204 .TP
6205 %d
6206 * @ Number of deleted messages
6207 .TP
6208 %L
6209 * @ Number of messages after limiting
6210 .TP
6211 %t
6212 * @ Number of tagged messages
6213 .TP
6214 %>X
6215 right justify the rest of the string and pad with \(lqX\(rq
6216 .TP
6217 %|X
6218 pad to the end of the line with \(lqX\(rq
6219 .TP
6220 %*X
6221 soft\-fill with character \(lqX\(rq as pad
6222 .RE
6223 .PD 1
6224 .IP
6225 * = Can be optionally printed if nonzero
6226 @ = Only applicable to the current folder
6227 .IP
6228 In order to use %S, %N, %F, and %!, $mail_check_stats must
6229 be \fIset\fP. When thus set, a suggested value for this option is
6230 \(rq%B%?F? [%F]?%* %?N?%N/?%S\(rq.
6231
6232
6233 .TP
6234 .B sidebar_indent_string
6235 .nf
6236 Type: string
6237 Default: \(lq \(rq
6238 .fi
6239 .IP
6240 This specifies the string that is used to indent mailboxes in the sidebar.
6241 It defaults to two spaces.
6242 .IP
6243 \fBSee also:\fP $sidebar_short_path, $sidebar_folder_indent, $sidebar_delim_chars.
6244
6245
6246 .TP
6247 .B sidebar_new_mail_only
6248 .nf
6249 Type: boolean
6250 Default: no
6251 .fi
6252 .IP
6253 When set, the sidebar will only display mailboxes containing new, or
6254 flagged, mail.
6255 .IP
6256 \fBSee also:\fP sidebar_whitelist.
6257
6258
6259 .TP
6260 .B sidebar_next_new_wrap
6261 .nf
6262 Type: boolean
6263 Default: no
6264 .fi
6265 .IP
6266 When set, the \fB<sidebar\-next\-new>\fP command will not stop and the end of
6267 the list of mailboxes, but wrap around to the beginning. The
6268 \fB<sidebar\-prev\-new>\fP command is similarly affected, wrapping around to
6269 the end of the list.
6270
6271
6272 .TP
6273 .B sidebar_relative_shortpath_indent
6274 .nf
6275 Type: boolean
6276 Default: no
6277 .fi
6278 .IP
6279 When set, this option changes how $sidebar_short_path and
6280 $sidebar_folder_indent perform shortening and indentation: both
6281 will look at the previous sidebar entries and shorten/indent
6282 relative to the most recent parent.
6283 .IP
6284 An example of this option set/unset for mailboxes listed in this
6285 order, with $sidebar_short_path=yes,
6286 $sidebar_folder_indent=yes, and $sidebar_indent_string=\(rq→\(rq:
6287 .RS
6288 .PD 0
6289 .TP
6290 \fBmailbox\fP
6291 \fBset\fP
6292 \fBunset\fP
6293 .TP
6294 \fB=a.b\fP
6295 \fB=a.b\fP
6296 \fB→b\fP
6297 .TP
6298 \fB=a.b.c.d\fP
6299 \fB→c.d\fP
6300 \fB→→→d\fP
6301 .TP
6302 \fB=a.b.e\fP
6303 \fB→e\fP
6304 \fB→→e\fP
6305 .RE
6306 .PD 1
6307 .IP
6308 The second line illustrates most clearly. With this option set,
6309 \fB=a.b.c.d\fP is shortened relative to \fB=a.b\fP, becoming
6310 \fBc.d\fP; it is also indented one place relative to \fB=a.b\fP.
6311 With this option unset \fB=a.b.c.d\fP is always shortened to the
6312 last part of the mailbox, \fBd\fP and is indented three places,
6313 with respect to $folder (represented by '=').
6314 .IP
6315 When set, the third line will also be indented and shortened
6316 relative to the first line.
6317
6318
6319 .TP
6320 .B sidebar_short_path
6321 .nf
6322 Type: boolean
6323 Default: no
6324 .fi
6325 .IP
6326 By default the sidebar will show the mailbox's path, relative to the
6327 $folder variable. Setting \fBsidebar_shortpath=yes\fP will shorten the
6328 names relative to the previous name. Here's an example:
6329 .RS
6330 .PD 0
6331 .TP
6332 \fBshortpath=no\fP
6333 \fBshortpath=yes\fP
6334 \fBshortpath=yes, folderindent=yes, indentstr=\(rq..\(rq\fP
6335 .TP
6336 \fBfruit\fP
6337 \fBfruit\fP
6338 \fBfruit\fP
6339 .TP
6340 \fBfruit.apple\fP
6341 \fBapple\fP
6342 \fB..apple\fP
6343 .TP
6344 \fBfruit.banana\fP
6345 \fBbanana\fP
6346 \fB..banana\fP
6347 .TP
6348 \fBfruit.cherry\fP
6349 \fBcherry\fP
6350 \fB..cherry\fP
6351 .RE
6352 .PD 1
6353 .IP
6354 \fBSee also:\fP $sidebar_delim_chars, $sidebar_folder_indent, $sidebar_indent_string.
6355
6356
6357 .TP
6358 .B sidebar_sort_method
6359 .nf
6360 Type: sort order
6361 Default: unsorted
6362 .fi
6363 .IP
6364 Specifies how to sort mailbox entries in the sidebar. By default, the
6365 entries are sorted alphabetically. Valid values:
6366 .RS
6367 .PD 0
6368 .TP
6369 \(hy alpha (alphabetically)
6370 .TP
6371 \(hy count (all message count)
6372 .TP
6373 \(hy flagged (flagged message count)
6374 .TP
6375 \(hy name (alphabetically)
6376 .TP
6377 \(hy new (unread message count)
6378 .TP
6379 \(hy path (alphabetically)
6380 .TP
6381 \(hy unread (unread message count)
6382 .TP
6383 \(hy unsorted
6384 .RE
6385 .PD 1
6386 .IP
6387 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
6388 order (example: \(lq\fBset sidebar_sort_method=reverse\-alpha\fP\(rq).
6389
6390
6391 .TP
6392 .B sidebar_use_mailbox_shortcuts
6393 .nf
6394 Type: boolean
6395 Default: no
6396 .fi
6397 .IP
6398 When set, sidebar mailboxes will be displayed with mailbox shortcut prefixes
6399 \(rq=\(rq or \(rq~\(rq.
6400 .IP
6401 When unset, the sidebar will trim off a matching $folder prefix
6402 but otherwise not use mailbox shortcuts.
6403
6404
6405 .TP
6406 .B sidebar_visible
6407 .nf
6408 Type: boolean
6409 Default: no
6410 .fi
6411 .IP
6412 This specifies whether or not to show sidebar. The sidebar shows a list of
6413 all your mailboxes.
6414 .IP
6415 \fBSee also:\fP $sidebar_format, $sidebar_width
6416
6417
6418 .TP
6419 .B sidebar_width
6420 .nf
6421 Type: number
6422 Default: 30
6423 .fi
6424 .IP
6425 This controls the width of the sidebar. It is measured in screen columns.
6426 For example: sidebar_width=20 could display 20 ASCII characters, or 10
6427 Chinese characters.
6428
6429
6430 .TP
6431 .B sig_dashes
6432 .nf
6433 Type: boolean
6434 Default: yes
6435 .fi
6436 .IP
6437 If \fIset\fP, a line containing \(lq\-\- \(rq (note the trailing space) will be inserted before your
6438 $signature. It is \fBstrongly\fP recommended that you not \fIunset\fP
6439 this variable unless your signature contains just your name. The
6440 reason for this is because many software packages use \(lq\-\- \\n\(rq to
6441 detect your signature. For example, Mutt has the ability to highlight
6442 the signature in a different color in the built\-in pager.
6443
6444
6445 .TP
6446 .B sig_on_top
6447 .nf
6448 Type: boolean
6449 Default: no
6450 .fi
6451 .IP
6452 If \fIset\fP, the signature will be included before any quoted or forwarded
6453 text. It is \fBstrongly\fP recommended that you do not set this variable
6454 unless you really know what you are doing, and are prepared to take
6455 some heat from netiquette guardians.
6456
6457
6458 .TP
6459 .B signature
6460 .nf
6461 Type: path
6462 Default: \(lq~/.signature\(rq
6463 .fi
6464 .IP
6465 Specifies the filename of your signature, which is appended to all
6466 outgoing messages. If the filename ends with a pipe (\(lq|\(rq), it is
6467 assumed that filename is a shell command and input should be read from
6468 its standard output.
6469
6470
6471 .TP
6472 .B simple_search
6473 .nf
6474 Type: string
6475 Default: \(lq~f %s | ~s %s\(rq
6476 .fi
6477 .IP
6478 Specifies how Mutt should expand a simple search into a real search
6479 pattern. A simple search is one that does not contain any of the \(lq~\(rq pattern
6480 modifiers. See \(lqpatterns\(rq for more information on search patterns.
6481 .IP
6482 For example, if you simply type \(lqjoe\(rq at a search or limit prompt, Mutt
6483 will automatically expand it to the value specified by this variable by
6484 replacing \(lq%s\(rq with the supplied string.
6485 For the default value, \(lqjoe\(rq would be expanded to: \(lq~f joe | ~s joe\(rq.
6486
6487
6488 .TP
6489 .B size_show_bytes
6490 .nf
6491 Type: boolean
6492 Default: no
6493 .fi
6494 .IP
6495 If \fIset\fP, message sizes will display bytes for values less than
6496 1 kilobyte. See formatstrings-size.
6497
6498
6499 .TP
6500 .B size_show_fractions
6501 .nf
6502 Type: boolean
6503 Default: yes
6504 .fi
6505 .IP
6506 If \fIset\fP, message sizes will be displayed with a single decimal value
6507 for sizes from 0 to 10 kilobytes and 1 to 10 megabytes.
6508 See formatstrings-size.
6509
6510
6511 .TP
6512 .B size_show_mb
6513 .nf
6514 Type: boolean
6515 Default: yes
6516 .fi
6517 .IP
6518 If \fIset\fP, message sizes will display megabytes for values greater than
6519 or equal to 1 megabyte. See formatstrings-size.
6520
6521
6522 .TP
6523 .B size_units_on_left
6524 .nf
6525 Type: boolean
6526 Default: no
6527 .fi
6528 .IP
6529 If \fIset\fP, message sizes units will be displayed to the left of the number.
6530 See formatstrings-size.
6531
6532
6533 .TP
6534 .B sleep_time
6535 .nf
6536 Type: number
6537 Default: 1
6538 .fi
6539 .IP
6540 Specifies time, in seconds, to pause while displaying certain informational
6541 messages, while moving from folder to folder and after expunging
6542 messages from the current folder. The default is to pause one second, so
6543 a value of zero for this option suppresses the pause.
6544
6545
6546 .TP
6547 .B smart_wrap
6548 .nf
6549 Type: boolean
6550 Default: yes
6551 .fi
6552 .IP
6553 Controls the display of lines longer than the screen width in the
6554 internal pager. If \fIset\fP, long lines are wrapped at a word boundary. If
6555 \fIunset\fP, lines are simply wrapped at the screen edge. Also see the
6556 $markers variable.
6557
6558
6559 .TP
6560 .B smileys
6561 .nf
6562 Type: regular expression
6563 Default: \(lq(>From )|(:[\-^]?[][)(><}{|/DP])\(rq
6564 .fi
6565 .IP
6566 The \fIpager\fP uses this variable to catch some common false
6567 positives of $quote_regexp, most notably smileys and not consider
6568 a line quoted text if it also matches $smileys. This mostly
6569 happens at the beginning of a line.
6570
6571
6572 .TP
6573 .B smime_ask_cert_label
6574 .nf
6575 Type: boolean
6576 Default: yes
6577 .fi
6578 .IP
6579 This flag controls whether you want to be asked to enter a label
6580 for a certificate about to be added to the database or not. It is
6581 \fIset\fP by default.
6582 (S/MIME only)
6583
6584
6585 .TP
6586 .B smime_ca_location
6587 .nf
6588 Type: path
6589 Default: \(lq\(rq
6590 .fi
6591 .IP
6592 This variable contains the name of either a directory, or a file which
6593 contains trusted certificates for use with OpenSSL.
6594 (S/MIME only)
6595
6596
6597 .TP
6598 .B smime_certificates
6599 .nf
6600 Type: path
6601 Default: \(lq\(rq
6602 .fi
6603 .IP
6604 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
6605 storage and retrieval of keys by itself. This is very basic right
6606 now, and keys and certificates are stored in two different
6607 directories, both named as the hash\-value retrieved from
6608 OpenSSL. There is an index file which contains mailbox\-address
6609 keyid pairs, and which can be manually edited. This option points to
6610 the location of the certificates.
6611 (S/MIME only)
6612
6613
6614 .TP
6615 .B smime_decrypt_command
6616 .nf
6617 Type: string
6618 Default: \(lq\(rq
6619 .fi
6620 .IP
6621 This format string specifies a command which is used to decrypt
6622 \fBapplication/x\-pkcs7\-mime\fP attachments.
6623 .IP
6624 The OpenSSL command formats have their own set of \fBprintf(3)\fP\-like sequences
6625 similar to PGP's:
6626 .RS
6627 .PD 0
6628 .TP
6629 %f
6630 Expands to the name of a file containing a message.
6631 .TP
6632 %s
6633 Expands to the name of a file containing the signature part
6634 of a \fBmultipart/signed\fP attachment when verifying it.
6635 .TP
6636 %k
6637 The key\-pair specified with $smime_default_key
6638 .TP
6639 %c
6640 One or more certificate IDs.
6641 .TP
6642 %a
6643 The algorithm used for encryption.
6644 .TP
6645 %d
6646 The message digest algorithm specified with $smime_sign_digest_alg.
6647 .TP
6648 %C
6649 CA location: Depending on whether $smime_ca_location
6650 points to a directory or file, this expands to
6651 \(lq\-CApath $smime_ca_location\(rq or \(lq\-CAfile $smime_ca_location\(rq.
6652 .RE
6653 .PD 1
6654 .IP
6655 For examples on how to configure these formats, see the \fBsmime.rc\fP in
6656 the \fBsamples/\fP subdirectory which has been installed on your system
6657 alongside the documentation.
6658 (S/MIME only)
6659
6660
6661 .TP
6662 .B smime_decrypt_use_default_key
6663 .nf
6664 Type: boolean
6665 Default: yes
6666 .fi
6667 .IP
6668 If \fIset\fP (default) this tells mutt to use the default key for decryption. Otherwise,
6669 if managing multiple certificate\-key\-pairs, mutt will try to use the mailbox\-address
6670 to determine the key to use. It will ask you to supply a key, if it can't find one.
6671 (S/MIME only)
6672
6673
6674 .TP
6675 .B smime_default_key
6676 .nf
6677 Type: string
6678 Default: \(lq\(rq
6679 .fi
6680 .IP
6681 This is the default key\-pair to use for S/MIME operations, and must be
6682 set to the keyid (the hash\-value that OpenSSL generates) to work properly.
6683 .IP
6684 It will be used for encryption (see $postpone_encrypt and
6685 $smime_self_encrypt). If GPGME is enabled, this is the key id displayed
6686 by gpgsm.
6687 .IP
6688 It will be used for decryption unless $smime_decrypt_use_default_key
6689 is \fIunset\fP.
6690 .IP
6691 It will also be used for signing unless $smime_sign_as is set.
6692 .IP
6693 The (now deprecated) \fIsmime_self_encrypt_as\fP is an alias for this
6694 variable, and should no longer be used.
6695 (S/MIME only)
6696
6697
6698 .TP
6699 .B smime_encrypt_command
6700 .nf
6701 Type: string
6702 Default: \(lq\(rq
6703 .fi
6704 .IP
6705 This command is used to create encrypted S/MIME messages.
6706 .IP
6707 This is a format string, see the $smime_decrypt_command command for
6708 possible \fBprintf(3)\fP\-like sequences.
6709 (S/MIME only)
6710
6711
6712 .TP
6713 .B smime_encrypt_with
6714 .nf
6715 Type: string
6716 Default: \(lqaes256\(rq
6717 .fi
6718 .IP
6719 This sets the algorithm that should be used for encryption.
6720 Valid choices are \(lqaes128\(rq, \(lqaes192\(rq, \(lqaes256\(rq, \(lqdes\(rq, \(lqdes3\(rq, \(lqrc2\-40\(rq, \(lqrc2\-64\(rq, \(lqrc2\-128\(rq.
6721 (S/MIME only)
6722
6723
6724 .TP
6725 .B smime_get_cert_command
6726 .nf
6727 Type: string
6728 Default: \(lq\(rq
6729 .fi
6730 .IP
6731 This command is used to extract X509 certificates from a PKCS7 structure.
6732 .IP
6733 This is a format string, see the $smime_decrypt_command command for
6734 possible \fBprintf(3)\fP\-like sequences.
6735 (S/MIME only)
6736
6737
6738 .TP
6739 .B smime_get_cert_email_command
6740 .nf
6741 Type: string
6742 Default: \(lq\(rq
6743 .fi
6744 .IP
6745 This command is used to extract the mail address(es) used for storing
6746 X509 certificates, and for verification purposes (to check whether the
6747 certificate was issued for the sender's mailbox).
6748 .IP
6749 This is a format string, see the $smime_decrypt_command command for
6750 possible \fBprintf(3)\fP\-like sequences.
6751 (S/MIME only)
6752
6753
6754 .TP
6755 .B smime_get_signer_cert_command
6756 .nf
6757 Type: string
6758 Default: \(lq\(rq
6759 .fi
6760 .IP
6761 This command is used to extract only the signers X509 certificate from a S/MIME
6762 signature, so that the certificate's owner may get compared to the
6763 email's \(lqFrom:\(rq field.
6764 .IP
6765 This is a format string, see the $smime_decrypt_command command for
6766 possible \fBprintf(3)\fP\-like sequences.
6767 (S/MIME only)
6768
6769
6770 .TP
6771 .B smime_import_cert_command
6772 .nf
6773 Type: string
6774 Default: \(lq\(rq
6775 .fi
6776 .IP
6777 This command is used to import a certificate via smime_keys.
6778 .IP
6779 This is a format string, see the $smime_decrypt_command command for
6780 possible \fBprintf(3)\fP\-like sequences.
6781 (S/MIME only)
6782
6783
6784 .TP
6785 .B smime_is_default
6786 .nf
6787 Type: boolean
6788 Default: no
6789 .fi
6790 .IP
6791 The default behavior of mutt is to use PGP on all auto\-sign/encryption
6792 operations. To override and to use OpenSSL instead this must be \fIset\fP.
6793 However, this has no effect while replying, since mutt will automatically
6794 select the same application that was used to sign/encrypt the original
6795 message. (Note that this variable can be overridden by unsetting $crypt_autosmime.)
6796 (S/MIME only)
6797
6798
6799 .TP
6800 .B smime_keys
6801 .nf
6802 Type: path
6803 Default: \(lq\(rq
6804 .fi
6805 .IP
6806 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
6807 storage and retrieval of keys/certs by itself. This is very basic right now,
6808 and stores keys and certificates in two different directories, both
6809 named as the hash\-value retrieved from OpenSSL. There is an index file
6810 which contains mailbox\-address keyid pair, and which can be manually
6811 edited. This option points to the location of the private keys.
6812 (S/MIME only)
6813
6814
6815 .TP
6816 .B smime_pkcs7_default_smime_type
6817 .nf
6818 Type: string
6819 Default: \(lqsigned\(rq
6820 .fi
6821 .IP
6822 The application/pkcs7\-mime \(lq.p7m\(rq type can contain EnvelopedData
6823 (encrypted) or SignedData. Senders should add a \(lqsmime\-type\(rq
6824 parameter to the content type, to help receiving MUAs correctly
6825 handle the data. Unfortunately, some clients (e.g. Outlook)
6826 don't add this parameter.
6827 .IP
6828 This option is used to determine which type to assume when the
6829 \(lqsmime\-type\(rq parameter is missing for \(lq.p7m\(rq file types.
6830 .IP
6831 Accepted values are \(lqenveloped\(rq and \(lqsigned\(rq.
6832
6833
6834 .TP
6835 .B smime_pk7out_command
6836 .nf
6837 Type: string
6838 Default: \(lq\(rq
6839 .fi
6840 .IP
6841 This command is used to extract PKCS7 structures of S/MIME signatures,
6842 in order to extract the public X509 certificate(s).
6843 .IP
6844 This is a format string, see the $smime_decrypt_command command for
6845 possible \fBprintf(3)\fP\-like sequences.
6846 (S/MIME only)
6847
6848
6849 .TP
6850 .B smime_self_encrypt
6851 .nf
6852 Type: boolean
6853 Default: yes
6854 .fi
6855 .IP
6856 When \fIset\fP, S/MIME encrypted messages will also be encrypted
6857 using the certificate in $smime_default_key.
6858 (S/MIME only)
6859
6860
6861 .TP
6862 .B smime_sign_as
6863 .nf
6864 Type: string
6865 Default: \(lq\(rq
6866 .fi
6867 .IP
6868 If you have a separate key to use for signing, you should set this
6869 to the signing key. Most people will only need to set $smime_default_key.
6870 (S/MIME only)
6871
6872
6873 .TP
6874 .B smime_sign_command
6875 .nf
6876 Type: string
6877 Default: \(lq\(rq
6878 .fi
6879 .IP
6880 This command is used to created S/MIME signatures of type
6881 \fBmultipart/signed\fP, which can be read by all mail clients.
6882 .IP
6883 This is a format string, see the $smime_decrypt_command command for
6884 possible \fBprintf(3)\fP\-like sequences. NOTE: %c and %k will default
6885 to $smime_sign_as if set, otherwise $smime_default_key.
6886 (S/MIME only)
6887
6888
6889 .TP
6890 .B smime_sign_digest_alg
6891 .nf
6892 Type: string
6893 Default: \(lqsha256\(rq
6894 .fi
6895 .IP
6896 This sets the algorithm that should be used for the signature message digest.
6897 Valid choices are \(lqmd5\(rq, \(lqsha1\(rq, \(lqsha224\(rq, \(lqsha256\(rq, \(lqsha384\(rq, \(lqsha512\(rq.
6898 (S/MIME only)
6899
6900
6901 .TP
6902 .B smime_sign_opaque_command
6903 .nf
6904 Type: string
6905 Default: \(lq\(rq
6906 .fi
6907 .IP
6908 This command is used to created S/MIME signatures of type
6909 \fBapplication/x\-pkcs7\-signature\fP, which can only be handled by mail
6910 clients supporting the S/MIME extension.
6911 .IP
6912 This is a format string, see the $smime_decrypt_command command for
6913 possible \fBprintf(3)\fP\-like sequences.
6914 (S/MIME only)
6915
6916
6917 .TP
6918 .B smime_timeout
6919 .nf
6920 Type: number (long)
6921 Default: 300
6922 .fi
6923 .IP
6924 The number of seconds after which a cached passphrase will expire if
6925 not used.
6926 (S/MIME only)
6927
6928
6929 .TP
6930 .B smime_verify_command
6931 .nf
6932 Type: string
6933 Default: \(lq\(rq
6934 .fi
6935 .IP
6936 This command is used to verify S/MIME signatures of type \fBmultipart/signed\fP.
6937 .IP
6938 This is a format string, see the $smime_decrypt_command command for
6939 possible \fBprintf(3)\fP\-like sequences.
6940 (S/MIME only)
6941
6942
6943 .TP
6944 .B smime_verify_opaque_command
6945 .nf
6946 Type: string
6947 Default: \(lq\(rq
6948 .fi
6949 .IP
6950 This command is used to verify S/MIME signatures of type
6951 \fBapplication/x\-pkcs7\-mime\fP.
6952 .IP
6953 This is a format string, see the $smime_decrypt_command command for
6954 possible \fBprintf(3)\fP\-like sequences.
6955 (S/MIME only)
6956
6957
6958 .TP
6959 .B smtp_authenticators
6960 .nf
6961 Type: string
6962 Default: \(lq\(rq
6963 .fi
6964 .IP
6965 This is a colon\-delimited list of authentication methods mutt may
6966 attempt to use to log in to an SMTP server, in the order mutt should
6967 try them. Authentication methods are any SASL mechanism, e.g.
6968 \(lqdigest\-md5\(rq, \(lqgssapi\(rq or \(lqcram\-md5\(rq.
6969 This option is case\-insensitive. If it is \(lqunset\(rq
6970 (the default) mutt will try all available methods, in order from
6971 most\-secure to least\-secure.
6972 .IP
6973 Example:
6974
6975 .IP
6976 .EX
6977 set smtp_authenticators=\(rqdigest\-md5:cram\-md5\(rq
6978
6979 .EE
6980
6981
6982 .TP
6983 .B smtp_oauth_refresh_command
6984 .nf
6985 Type: string
6986 Default: \(lq\(rq
6987 .fi
6988 .IP
6989 The command to run to generate an OAUTH refresh token for
6990 authorizing your connection to your SMTP server. This command will be
6991 run on every connection attempt that uses the OAUTHBEARER authentication
6992 mechanism. See \(lqoauth\(rq for details.
6993
6994
6995 .TP
6996 .B smtp_pass
6997 .nf
6998 Type: string
6999 Default: \(lq\(rq
7000 .fi
7001 .IP
7002 Specifies the password for your SMTP account. If \fIunset\fP, Mutt will
7003 prompt you for your password when you first send mail via SMTP.
7004 See $smtp_url to configure mutt to send mail via SMTP.
7005 .IP
7006 \fBWarning\fP: you should only use this option when you are on a
7007 fairly secure machine, because the superuser can read your muttrc even
7008 if you are the only one who can read the file.
7009
7010
7011 .TP
7012 .B smtp_url
7013 .nf
7014 Type: string
7015 Default: \(lq\(rq
7016 .fi
7017 .IP
7018 Defines the SMTP smarthost where sent messages should relayed for
7019 delivery. This should take the form of an SMTP URL, e.g.:
7020
7021 .IP
7022 .EX
7023 smtp[s]://[user[:pass]@]host[:port]
7024
7025 .EE
7026 .IP
7027 where \(lq[...]\(rq denotes an optional part.
7028 Setting this variable overrides the value of the $sendmail
7029 variable.
7030 .IP
7031 Also see $write_bcc.
7032
7033
7034 .TP
7035 .B socket_receive_timeout
7036 .nf
7037 Type: number
7038 Default: 0
7039 .fi
7040 .IP
7041 Causes Mutt to timeout any socket read operation (e.g. SSL_read) after
7042 this many seconds. A zero (default) or negative value causes Mutt to wait
7043 indefinitely for the read to complete.
7044
7045
7046 .TP
7047 .B socket_send_timeout
7048 .nf
7049 Type: number
7050 Default: 0
7051 .fi
7052 .IP
7053 Causes Mutt to timeout any socket write operation (e.g. SSL_write) after
7054 this many seconds. A zero (default) or negative value causes Mutt to wait
7055 indefinitely for the write to complete.
7056
7057
7058 .TP
7059 .B sort
7060 .nf
7061 Type: sort order
7062 Default: date
7063 .fi
7064 .IP
7065 Specifies how to sort messages in the \(lqindex\(rq menu. Valid values
7066 are:
7067 .RS
7068 .PD 0
7069 .TP
7070 \(hy date or date\-sent
7071 .TP
7072 \(hy date\-received
7073 .TP
7074 \(hy from
7075 .TP
7076 \(hy mailbox\-order (unsorted)
7077 .TP
7078 \(hy score
7079 .TP
7080 \(hy size
7081 .TP
7082 \(hy spam
7083 .TP
7084 \(hy subject
7085 .TP
7086 \(hy threads
7087 .TP
7088 \(hy to
7089 .RE
7090 .PD 1
7091 .IP
7092 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
7093 order (example: \(lq\fBset sort=reverse\-date\-sent\fP\(rq).
7094 .IP
7095 For values except \(lqthreads\(rq, this provides the primary sort
7096 method. When two message sort values are equal, $sort_aux will
7097 be used for a secondary sort.
7098 .IP
7099 When set to \(lqthreads\(rq, Mutt threads messages in the index. It
7100 uses the variable $sort_thread_groups to sort between threads
7101 (at the top/root level), and $sort_aux to sort sub\-threads and
7102 children.
7103
7104
7105 .TP
7106 .B sort_alias
7107 .nf
7108 Type: sort order
7109 Default: alias
7110 .fi
7111 .IP
7112 Specifies how the entries in the \(lqalias\(rq menu are sorted. The
7113 following are legal values:
7114 .RS
7115 .PD 0
7116 .TP
7117 \(hy address (sort alphabetically by email address)
7118 .TP
7119 \(hy alias (sort alphabetically by alias name)
7120 .TP
7121 \(hy unsorted (leave in order specified in .muttrc)
7122 .RE
7123 .PD 1
7124
7125 .TP
7126 .B sort_aux
7127 .nf
7128 Type: sort order
7129 Default: date
7130 .fi
7131 .IP
7132 For non\-threaded mode, this provides a secondary sort for
7133 messages in the \(lqindex\(rq menu, used when the $sort value is
7134 equal for two messages.
7135 .IP
7136 When sorting by threads, this variable controls how the branches
7137 of the thread trees are sorted. This can be set to any value
7138 that $sort can, except \(lqthreads\(rq (in that case, mutt will just
7139 use \(lqdate\-sent\(rq). You can also specify the \(lqlast\-\(rq prefix in
7140 addition to the \(lqreverse\-\(rq prefix, but \(lqlast\-\(rq must come
7141 after \(lqreverse\-\(rq. The \(lqlast\-\(rq prefix causes messages to be
7142 sorted against its siblings by which has the last descendant,
7143 using the rest of $sort_aux as an ordering. For instance,
7144
7145 .IP
7146 .EX
7147 set sort_aux=last\-date\-received
7148
7149 .EE
7150 .IP
7151 would mean that if a new message is received in a sub\-thread,
7152 that sub\-thread becomes the last one displayed.
7153 .IP
7154 Note: For reversed\-threads $sort
7155 order, $sort_aux is reversed again (which is not the right thing to do,
7156 but kept to not break any existing configuration setting).
7157
7158
7159 .TP
7160 .B sort_browser
7161 .nf
7162 Type: sort order
7163 Default: alpha
7164 .fi
7165 .IP
7166 Specifies how to sort entries in the file browser. By default, the
7167 entries are sorted alphabetically. Valid values:
7168 .RS
7169 .PD 0
7170 .TP
7171 \(hy alpha (alphabetically)
7172 .TP
7173 \(hy count
7174 .TP
7175 \(hy date
7176 .TP
7177 \(hy size
7178 .TP
7179 \(hy unread
7180 .TP
7181 \(hy unsorted
7182 .RE
7183 .PD 1
7184 .IP
7185 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
7186 order (example: \(lq\fBset sort_browser=reverse\-date\fP\(rq).
7187
7188
7189 .TP
7190 .B sort_browser_mailboxes
7191 .nf
7192 Type: sort order
7193 Default: unsorted
7194 .fi
7195 .IP
7196 Specifies how to sort entries in the mailbox browser. By default, the
7197 entries are unsorted, displayed in the same order as listed
7198 in the \(lqmailboxes\(rq command. Valid values:
7199 .RS
7200 .PD 0
7201 .TP
7202 \(hy alpha (alphabetically)
7203 .TP
7204 \(hy count
7205 .TP
7206 \(hy date
7207 .TP
7208 \(hy size
7209 .TP
7210 \(hy unread
7211 .TP
7212 \(hy unsorted
7213 .RE
7214 .PD 1
7215 .IP
7216 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
7217 order (example: \(lq\fBset sort_browser_mailboxes=reverse\-alpha\fP\(rq).
7218
7219
7220 .TP
7221 .B sort_re
7222 .nf
7223 Type: boolean
7224 Default: yes
7225 .fi
7226 .IP
7227 This variable is only useful when sorting by threads with
7228 $strict_threads \fIunset\fP. In that case, it changes the heuristic
7229 mutt uses to thread messages by subject. With $sort_re \fIset\fP, mutt will
7230 only attach a message as the child of another message by subject if
7231 the subject of the child message starts with a substring matching the
7232 setting of $reply_regexp. With $sort_re \fIunset\fP, mutt will attach
7233 the message whether or not this is the case, as long as the
7234 non\-$reply_regexp parts of both messages are identical.
7235
7236
7237 .TP
7238 .B sort_thread_groups
7239 .nf
7240 Type: sort order
7241 Default: aux
7242 .fi
7243 .IP
7244 When sorting by threads, this variable controls how threads are
7245 sorted in relation to other threads (at the top/root level).
7246 This can be set to any value that $sort can, except \(lqthreads\(rq.
7247 You can also specify the \(lqlast\-\(rq prefix in addition to the
7248 \(lqreverse\-\(rq prefix, but \(lqlast\-\(rq must come after \(lqreverse\-\(rq.
7249 The \(lqlast\-\(rq prefix causes messages to be sorted against its
7250 siblings by which has the last descendant, using the rest of
7251 $sort_thread_groups as an ordering.
7252 .IP
7253 For backward compatibility, the default value is \(lqaux\(rq, which
7254 means to use $sort_aux for top\-level thread sorting too. The
7255 value \(lqaux\(rq does not respect \(lqlast\-\(rq or \(lqreverse\-\(rq
7256 prefixes, it simply delegates sorting directly to $sort_aux.
7257 .IP
7258 Note: For reversed\-threads $sort order, $sort_thread_groups is
7259 reversed again (which is not the right thing to do, but kept to
7260 not break any existing configuration setting).
7261
7262
7263 .TP
7264 .B spam_separator
7265 .nf
7266 Type: string
7267 Default: \(lq,\(rq
7268 .fi
7269 .IP
7270 This variable controls what happens when multiple spam headers
7271 are matched: if \fIunset\fP, each successive header will overwrite any
7272 previous matches value for the spam label. If \fIset\fP, each successive
7273 match will append to the previous, using this variable's value as a
7274 separator.
7275
7276
7277 .TP
7278 .B spoolfile
7279 .nf
7280 Type: path
7281 Default: \(lq\(rq
7282 .fi
7283 .IP
7284 If your default mailbox or spool file is in a non\-default place where Mutt
7285 cannot find it, you can specify its location with this variable. Mutt will
7286 initially set this variable to the value of the environment
7287 variable \fB$MAIL\fP or \fB$MAILDIR\fP if either is defined.
7288 .IP
7289 Note: Despite the name, this can refer to a local or remote mailbox, e.g.,
7290 \(rq+INBOX\(rq.
7291
7292
7293 .TP
7294 .B ssl_ca_certificates_file
7295 .nf
7296 Type: path
7297 Default: \(lq\(rq
7298 .fi
7299 .IP
7300 This variable specifies a file containing trusted CA certificates.
7301 Any server certificate that is signed with one of these CA
7302 certificates is also automatically accepted. (GnuTLS only)
7303 .IP
7304 Example:
7305
7306 .IP
7307 .EX
7308 set ssl_ca_certificates_file=/etc/ssl/certs/ca\-certificates.crt
7309
7310 .EE
7311
7312
7313 .TP
7314 .B ssl_client_cert
7315 .nf
7316 Type: path
7317 Default: \(lq\(rq
7318 .fi
7319 .IP
7320 The file containing a client certificate and its associated private
7321 key.
7322
7323
7324 .TP
7325 .B ssl_force_tls
7326 .nf
7327 Type: boolean
7328 Default: yes
7329 .fi
7330 .IP
7331 If this variable is \fIset\fP, Mutt will require that all connections
7332 to remote servers be encrypted. Furthermore it will attempt to
7333 negotiate TLS even if the server does not advertise the capability,
7334 since it would otherwise have to abort the connection anyway. This
7335 option supersedes $ssl_starttls.
7336
7337
7338 .TP
7339 .B ssl_min_dh_prime_bits
7340 .nf
7341 Type: number
7342 Default: 0
7343 .fi
7344 .IP
7345 This variable specifies the minimum acceptable prime size (in bits)
7346 for use in any Diffie\-Hellman key exchange. A value of 0 will use
7347 the default from the GNUTLS library. (GnuTLS only)
7348
7349
7350 .TP
7351 .B ssl_starttls
7352 .nf
7353 Type: quadoption
7354 Default: yes
7355 .fi
7356 .IP
7357 If \fIset\fP (the default), mutt will attempt to use \fBSTARTTLS\fP on servers
7358 advertising the capability. When \fIunset\fP, mutt will not attempt to
7359 use \fBSTARTTLS\fP regardless of the server's capabilities.
7360 .IP
7361 \fBNote\fP that \fBSTARTTLS\fP is subject to many kinds of
7362 attacks, including the ability of a machine\-in\-the\-middle to
7363 suppress the advertising of support. Setting $ssl_force_tls is
7364 recommended if you rely on \fBSTARTTLS\fP.
7365
7366
7367 .TP
7368 .B ssl_use_sslv2
7369 .nf
7370 Type: boolean
7371 Default: no
7372 .fi
7373 .IP
7374 If \fIset\fP , Mutt will use SSLv2 when communicating with servers that
7375 request it. \fBN.B. As of 2011, SSLv2 is considered insecure, and using
7376 is inadvisable. See https://tools.ietf.org/html/rfc6176 .\fP
7377 (OpenSSL only)
7378
7379
7380 .TP
7381 .B ssl_use_sslv3
7382 .nf
7383 Type: boolean
7384 Default: no
7385 .fi
7386 .IP
7387 If \fIset\fP , Mutt will use SSLv3 when communicating with servers that
7388 request it. \fBN.B. As of 2015, SSLv3 is considered insecure, and using
7389 it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
7390
7391
7392 .TP
7393 .B ssl_use_tlsv1
7394 .nf
7395 Type: boolean
7396 Default: no
7397 .fi
7398 .IP
7399 If \fIset\fP , Mutt will use TLSv1.0 when communicating with servers that
7400 request it. \fBN.B. As of 2015, TLSv1.0 is considered insecure, and using
7401 it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
7402
7403
7404 .TP
7405 .B ssl_use_tlsv1_1
7406 .nf
7407 Type: boolean
7408 Default: no
7409 .fi
7410 .IP
7411 If \fIset\fP , Mutt will use TLSv1.1 when communicating with servers that
7412 request it. \fBN.B. As of 2015, TLSv1.1 is considered insecure, and using
7413 it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
7414
7415
7416 .TP
7417 .B ssl_use_tlsv1_2
7418 .nf
7419 Type: boolean
7420 Default: yes
7421 .fi
7422 .IP
7423 If \fIset\fP , Mutt will use TLSv1.2 when communicating with servers that
7424 request it.
7425
7426
7427 .TP
7428 .B ssl_use_tlsv1_3
7429 .nf
7430 Type: boolean
7431 Default: yes
7432 .fi
7433 .IP
7434 If \fIset\fP , Mutt will use TLSv1.3 when communicating with servers that
7435 request it.
7436
7437
7438 .TP
7439 .B ssl_usesystemcerts
7440 .nf
7441 Type: boolean
7442 Default: yes
7443 .fi
7444 .IP
7445 If set to \fIyes\fP, mutt will use CA certificates in the
7446 system\-wide certificate store when checking if a server certificate
7447 is signed by a trusted CA. (OpenSSL only)
7448
7449
7450 .TP
7451 .B ssl_verify_dates
7452 .nf
7453 Type: boolean
7454 Default: yes
7455 .fi
7456 .IP
7457 If \fIset\fP (the default), mutt will not automatically accept a server
7458 certificate that is either not yet valid or already expired. You should
7459 only unset this for particular known hosts, using the
7460 \fB<account-hook>\fP function.
7461
7462
7463 .TP
7464 .B ssl_verify_host
7465 .nf
7466 Type: boolean
7467 Default: yes
7468 .fi
7469 .IP
7470 If \fIset\fP (the default), mutt will not automatically accept a server
7471 certificate whose host name does not match the host used in your folder
7472 URL. You should only unset this for particular known hosts, using
7473 the \fB<account-hook>\fP function.
7474
7475
7476 .TP
7477 .B ssl_verify_host_override
7478 .nf
7479 Type: string
7480 Default: \(lq\(rq
7481 .fi
7482 .IP
7483 Defines an alternate host name to verify the server certificate against.
7484 This should not be set unless you are sure what you are doing, but it
7485 might be useful for connection to a .onion host without a properly
7486 configured host name in the certificate. See $ssl_verify_host.
7487
7488
7489 .TP
7490 .B ssl_verify_partial_chains
7491 .nf
7492 Type: boolean
7493 Default: no
7494 .fi
7495 .IP
7496 This option should not be changed from the default unless you understand
7497 what you are doing.
7498 .IP
7499 Setting this variable to \fIyes\fP will permit verifying partial
7500 certification chains, i. e. a certificate chain where not the root,
7501 but an intermediate certificate CA, or the host certificate, are
7502 marked trusted (in $certificate_file), without marking the root
7503 signing CA as trusted.
7504 .IP
7505 (OpenSSL 1.0.2b and newer only).
7506
7507
7508 .TP
7509 .B ssl_ciphers
7510 .nf
7511 Type: string
7512 Default: \(lq\(rq
7513 .fi
7514 .IP
7515 Contains a colon\-separated list of ciphers to use when using SSL.
7516 For OpenSSL, see ciphers(1) for the syntax of the string.
7517 .IP
7518 For GnuTLS, this option will be used in place of \(rqNORMAL\(rq at the
7519 start of the priority string. See gnutls_priority_init(3) for the
7520 syntax and more details. (Note: GnuTLS version 2.1.7 or higher is
7521 required.)
7522
7523
7524 .TP
7525 .B status_chars
7526 .nf
7527 Type: string
7528 Default: \(lq\-*%A\(rq
7529 .fi
7530 .IP
7531 Controls the characters used by the \(lq%r\(rq indicator in
7532 $status_format. The first character is used when the mailbox is
7533 unchanged. The second is used when the mailbox has been changed, and
7534 it needs to be resynchronized. The third is used if the mailbox is in
7535 read\-only mode, or if the mailbox will not be written when exiting
7536 that mailbox (You can toggle whether to write changes to a mailbox
7537 with the \fB<toggle\-write>\fP operation, bound by default to \(lq%\(rq). The fourth
7538 is used to indicate that the current folder has been opened in attach\-
7539 message mode (Certain operations like composing a new mail, replying,
7540 forwarding, etc. are not permitted in this mode).
7541
7542
7543 .TP
7544 .B status_format
7545 .nf
7546 Type: string (localized)
7547 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?%?B? Back:%B?%?l? %l?]\-\-\-(%s/%?T?%T/?%S)\-%>\-(%P)\-\-\-\(rq
7548 .fi
7549 .IP
7550 Controls the format of the status line displayed in the \(lqindex\(rq
7551 menu. This string is similar to $index_format, but has its own
7552 set of \fBprintf(3)\fP\-like sequences:
7553 .RS
7554 .PD 0
7555 .TP
7556 %b
7557 number of mailboxes with new mail *
7558 .TP
7559 %B
7560 number of backgrounded editing sessions *
7561 .TP
7562 %d
7563 number of deleted messages *
7564 .TP
7565 %f
7566 the full pathname of the current mailbox
7567 .TP
7568 %F
7569 number of flagged messages *
7570 .TP
7571 %h
7572 local hostname
7573 .TP
7574 %l
7575 size (in bytes) of the current mailbox (see formatstrings-size) *
7576 .TP
7577 %L
7578 size (in bytes) of the messages shown
7579 (i.e., which match the current limit) (see formatstrings-size) *
7580 .TP
7581 %m
7582 the number of messages in the mailbox *
7583 .TP
7584 %M
7585 the number of messages shown (i.e., which match the current limit) *
7586 .TP
7587 %n
7588 number of new messages in the mailbox *
7589 .TP
7590 %o
7591 number of old unread messages *
7592 .TP
7593 %p
7594 number of postponed messages *
7595 .TP
7596 %P
7597 percentage of the way through the index
7598 .TP
7599 %r
7600 modified/read\-only/won't\-write/attach\-message indicator,
7601 according to $status_chars
7602 .TP
7603 %R
7604 number of read messages *
7605 .TP
7606 %s
7607 current sorting mode ($sort)
7608 .TP
7609 %S
7610 current aux sorting method ($sort_aux)
7611 .TP
7612 %t
7613 number of tagged messages *
7614 .TP
7615 %T
7616 current thread group sorting method ($sort_thread_groups) *
7617 .TP
7618 %u
7619 number of unread messages *
7620 .TP
7621 %v
7622 Mutt version string
7623 .TP
7624 %V
7625 currently active limit pattern, if any *
7626 .TP
7627 %>X
7628 right justify the rest of the string and pad with \(lqX\(rq
7629 .TP
7630 %|X
7631 pad to the end of the line with \(lqX\(rq
7632 .TP
7633 %*X
7634 soft\-fill with character \(lqX\(rq as pad
7635 .RE
7636 .PD 1
7637 .IP
7638 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
7639 .IP
7640 * = can be optionally printed if nonzero
7641 .IP
7642 Some of the above sequences can be used to optionally print a string
7643 if their value is nonzero. For example, you may only want to see the
7644 number of flagged messages if such messages exist, since zero is not
7645 particularly meaningful. To optionally print a string based upon one
7646 of the above sequences, the following construct is used:
7647 .IP
7648 \fB%?<sequence_char>?<optional_string>?\fP
7649 .IP
7650 where \fIsequence_char\fP is a character from the table above, and
7651 \fIoptional_string\fP is the string you would like printed if
7652 \fIsequence_char\fP is nonzero. \fIoptional_string\fP \fBmay\fP contain
7653 other sequences as well as normal text, but you may \fBnot\fP nest
7654 optional strings.
7655 .IP
7656 Here is an example illustrating how to optionally print the number of
7657 new messages in a mailbox:
7658 .IP
7659 \fB%?n?%n new messages.?\fP
7660 .IP
7661 You can also switch between two strings using the following construct:
7662 .IP
7663 \fB%?<sequence_char>?<if_string>&<else_string>?\fP
7664 .IP
7665 If the value of \fIsequence_char\fP is non\-zero, \fIif_string\fP will
7666 be expanded, otherwise \fIelse_string\fP will be expanded.
7667 .IP
7668 You can force the result of any \fBprintf(3)\fP\-like sequence to be lowercase
7669 by prefixing the sequence character with an underscore (\(lq_\(rq) sign.
7670 For example, if you want to display the local hostname in lowercase,
7671 you would use: \(lq\fB%_h\fP\(rq.
7672 .IP
7673 If you prefix the sequence character with a colon (\(lq:\(rq) character, mutt
7674 will replace any dots in the expansion by underscores. This might be helpful
7675 with IMAP folders that don't like dots in folder names.
7676
7677
7678 .TP
7679 .B status_on_top
7680 .nf
7681 Type: boolean
7682 Default: no
7683 .fi
7684 .IP
7685 Setting this variable causes the \(lqstatus bar\(rq to be displayed on
7686 the first line of the screen rather than near the bottom. If $help
7687 is \fIset\fP, too it'll be placed at the bottom.
7688
7689
7690 .TP
7691 .B strict_threads
7692 .nf
7693 Type: boolean
7694 Default: no
7695 .fi
7696 .IP
7697 If \fIset\fP, threading will only make use of the \(lqIn\-Reply\-To\(rq and
7698 \(lqReferences:\(rq fields when you $sort by message threads. By
7699 default, messages with the same subject are grouped together in
7700 \(lqpseudo threads.\(rq. This may not always be desirable, such as in a
7701 personal mailbox where you might have several unrelated messages with
7702 the subjects like \(lqhi\(rq which will get grouped together. See also
7703 $sort_re for a less drastic way of controlling this
7704 behavior.
7705
7706
7707 .TP
7708 .B suspend
7709 .nf
7710 Type: boolean
7711 Default: yes
7712 .fi
7713 .IP
7714 When \fIunset\fP, mutt won't stop when the user presses the terminal's
7715 \fIsusp\fP key, usually \(lq^Z\(rq. This is useful if you run mutt
7716 inside an xterm using a command like \(lq\fBxterm \-e mutt\fP\(rq.
7717
7718
7719 .TP
7720 .B text_flowed
7721 .nf
7722 Type: boolean
7723 Default: no
7724 .fi
7725 .IP
7726 When \fIset\fP, mutt will generate \(lqformat=flowed\(rq bodies with a content type
7727 of \(lq\fBtext/plain; format=flowed\fP\(rq.
7728 This format is easier to handle for some mailing software, and generally
7729 just looks like ordinary text. To actually make use of this format's
7730 features, you'll need support in your editor.
7731 .IP
7732 The option only controls newly composed messages. Postponed messages,
7733 resent messages, and draft messages (via \-H on the command line) will
7734 use the content\-type of the source message.
7735 .IP
7736 Note that $indent_string is ignored when this option is \fIset\fP.
7737
7738
7739 .TP
7740 .B thorough_search
7741 .nf
7742 Type: boolean
7743 Default: yes
7744 .fi
7745 .IP
7746 Affects the \fB~b\fP, \fB~B\fP, and \fB~h\fP search operations described in
7747 section \(lqpatterns\(rq. If \fIset\fP, the headers and body/attachments of
7748 messages to be searched are decoded before searching. If \fIunset\fP,
7749 messages are searched as they appear in the folder.
7750 .IP
7751 Users searching attachments or for non\-ASCII characters should \fIset\fP
7752 this value because decoding also includes MIME parsing/decoding and possible
7753 character set conversions. Otherwise mutt will attempt to match against the
7754 raw message received (for example quoted\-printable encoded or with encoded
7755 headers) which may lead to incorrect search results.
7756
7757
7758 .TP
7759 .B thread_received
7760 .nf
7761 Type: boolean
7762 Default: no
7763 .fi
7764 .IP
7765 When \fIset\fP, mutt uses the date received rather than the date sent
7766 to thread messages by subject.
7767
7768
7769 .TP
7770 .B tilde
7771 .nf
7772 Type: boolean
7773 Default: no
7774 .fi
7775 .IP
7776 When \fIset\fP, the internal\-pager will pad blank lines to the bottom of the
7777 screen with a tilde (\(lq~\(rq).
7778
7779
7780 .TP
7781 .B time_inc
7782 .nf
7783 Type: number
7784 Default: 0
7785 .fi
7786 .IP
7787 Along with $read_inc, $write_inc, and $net_inc, this
7788 variable controls the frequency with which progress updates are
7789 displayed. It suppresses updates less than $time_inc milliseconds
7790 apart. This can improve throughput on systems with slow terminals,
7791 or when running mutt on a remote system.
7792 .IP
7793 Also see the \(lqtuning\(rq section of the manual for performance considerations.
7794
7795
7796 .TP
7797 .B timeout
7798 .nf
7799 Type: number
7800 Default: 600
7801 .fi
7802 .IP
7803 When Mutt is waiting for user input either idling in menus or
7804 in an interactive prompt, Mutt would block until input is
7805 present. Depending on the context, this would prevent certain
7806 operations from working, like checking for new mail or keeping
7807 an IMAP connection alive.
7808 .IP
7809 This variable controls how many seconds Mutt will at most wait
7810 until it aborts waiting for input, performs these operations and
7811 continues to wait for input.
7812 .IP
7813 A value of zero or less will cause Mutt to never time out.
7814
7815
7816 .TP
7817 .B tmpdir
7818 .nf
7819 Type: path
7820 Default: \(lq\(rq
7821 .fi
7822 .IP
7823 This variable allows you to specify where Mutt will place its
7824 temporary files needed for displaying and composing messages. If
7825 this variable is not set, the environment variable \fB$TMPDIR\fP is
7826 used. If \fB$TMPDIR\fP is not set then \(lq\fB/tmp\fP\(rq is used.
7827
7828
7829 .TP
7830 .B to_chars
7831 .nf
7832 Type: string
7833 Default: \(lq +TCFL\(rq
7834 .fi
7835 .IP
7836 Controls the character used to indicate mail addressed to you. The
7837 first character is the one used when the mail is \fInot\fP addressed to your
7838 address. The second is used when you are the only
7839 recipient of the message. The third is when your address
7840 appears in the \(lqTo:\(rq header field, but you are not the only recipient of
7841 the message. The fourth character is used when your
7842 address is specified in the \(lqCc:\(rq header field, but you are not the only
7843 recipient. The fifth character is used to indicate mail that was sent
7844 by \fIyou\fP. The sixth character is used to indicate when a mail
7845 was sent to a mailing\-list you subscribe to.
7846
7847
7848 .TP
7849 .B trash
7850 .nf
7851 Type: path
7852 Default: \(lq\(rq
7853 .fi
7854 .IP
7855 If set, this variable specifies the path of the trash folder where the
7856 mails marked for deletion will be moved, instead of being irremediably
7857 purged.
7858 .IP
7859 NOTE: When you delete a message in the trash folder, it is really
7860 deleted, so that you have a way to clean the trash.
7861
7862
7863 .TP
7864 .B ts_icon_format
7865 .nf
7866 Type: string (localized)
7867 Default: \(lqM%?n?AIL&ail?\(rq
7868 .fi
7869 .IP
7870 Controls the format of the icon title, as long as \(lq$ts_enabled\(rq is set.
7871 This string is identical in formatting to the one used by
7872 \(lq$status_format\(rq.
7873
7874
7875 .TP
7876 .B ts_enabled
7877 .nf
7878 Type: boolean
7879 Default: no
7880 .fi
7881 .IP
7882 Controls whether mutt tries to set the terminal status line and icon name.
7883 Most terminal emulators emulate the status line in the window title.
7884
7885
7886 .TP
7887 .B ts_status_format
7888 .nf
7889 Type: string (localized)
7890 Default: \(lqMutt with %?m?%m messages&no messages?%?n? [%n NEW]?\(rq
7891 .fi
7892 .IP
7893 Controls the format of the terminal status line (or window title),
7894 provided that \(lq$ts_enabled\(rq has been set. This string is identical in
7895 formatting to the one used by \(lq$status_format\(rq.
7896
7897
7898 .TP
7899 .B tunnel
7900 .nf
7901 Type: string
7902 Default: \(lq\(rq
7903 .fi
7904 .IP
7905 Setting this variable will cause mutt to open a pipe to a command
7906 instead of a raw socket. You may be able to use this to set up
7907 preauthenticated connections to your IMAP/POP3/SMTP server. Example:
7908
7909 .IP
7910 .EX
7911 set tunnel=\(rqssh \-q mailhost.net /usr/local/libexec/imapd\(rq
7912
7913 .EE
7914 .IP
7915 Note: For this example to work you must be able to log in to the remote
7916 machine without having to enter a password.
7917 .IP
7918 When set, Mutt uses the tunnel for all remote connections.
7919 Please see \(lqaccount-hook\(rq in the manual for how to use different
7920 tunnel commands per connection.
7921
7922
7923 .TP
7924 .B tunnel_is_secure
7925 .nf
7926 Type: boolean
7927 Default: yes
7928 .fi
7929 .IP
7930 When \fIset\fP, Mutt will assume the $tunnel connection does not need
7931 STARTTLS to be enabled. It will also allow IMAP PREAUTH server
7932 responses inside a tunnel to proceed. This is appropriate if $tunnel
7933 uses ssh or directly invokes the server locally.
7934 .IP
7935 When \fIunset\fP, Mutt will negotiate STARTTLS according to the
7936 ssl_starttls and ssl_force_tls variables. If ssl_force_tls is
7937 set, Mutt will abort connecting if an IMAP server responds with PREAUTH.
7938 This setting is appropriate if $tunnel does not provide security and
7939 could be tampered with by attackers.
7940
7941
7942 .TP
7943 .B uncollapse_jump
7944 .nf
7945 Type: boolean
7946 Default: no
7947 .fi
7948 .IP
7949 When \fIset\fP, Mutt will jump to the next unread message, if any,
7950 when the current thread is \fIun\fPcollapsed.
7951
7952
7953 .TP
7954 .B uncollapse_new
7955 .nf
7956 Type: boolean
7957 Default: yes
7958 .fi
7959 .IP
7960 When \fIset\fP, Mutt will automatically uncollapse any collapsed
7961 thread that receives a newly delivered message. When
7962 \fIunset\fP, collapsed threads will remain collapsed. The
7963 presence of the newly delivered message will still affect index
7964 sorting, though.
7965
7966
7967 .TP
7968 .B use_8bitmime
7969 .nf
7970 Type: boolean
7971 Default: no
7972 .fi
7973 .IP
7974 \fBWarning:\fP do not set this variable unless you are using a version
7975 of sendmail which supports the \fB\-B8BITMIME\fP flag (such as sendmail
7976 8.8.x) or you may not be able to send mail.
7977 .IP
7978 When \fIset\fP, Mutt will invoke $sendmail with the \fB\-B8BITMIME\fP
7979 flag when sending 8\-bit messages to enable ESMTP negotiation.
7980
7981
7982 .TP
7983 .B use_domain
7984 .nf
7985 Type: boolean
7986 Default: yes
7987 .fi
7988 .IP
7989 When \fIset\fP, Mutt will qualify all local addresses (ones without the
7990 \(lq@host\(rq portion) with the value of $hostname. If \fIunset\fP, no
7991 addresses will be qualified.
7992
7993
7994 .TP
7995 .B use_envelope_from
7996 .nf
7997 Type: boolean
7998 Default: no
7999 .fi
8000 .IP
8001 When \fIset\fP, mutt will set the \fIenvelope\fP sender of the message.
8002 If $envelope_from_address is \fIset\fP, it will be used as the sender
8003 address. If \fIunset\fP, mutt will attempt to derive the sender from the
8004 \(lqFrom:\(rq header.
8005 .IP
8006 Note that this information is passed to sendmail command using the
8007 \fB\-f\fP command line switch. Therefore setting this option is not useful
8008 if the $sendmail variable already contains \fB\-f\fP or if the
8009 executable pointed to by $sendmail doesn't support the \fB\-f\fP switch.
8010
8011
8012 .TP
8013 .B use_from
8014 .nf
8015 Type: boolean
8016 Default: yes
8017 .fi
8018 .IP
8019 When \fIset\fP, Mutt will generate the \(lqFrom:\(rq header field when
8020 sending messages. If \fIunset\fP, no \(lqFrom:\(rq header field will be
8021 generated unless the user explicitly sets one using the \(lqmy_hdr\(rq
8022 command.
8023
8024
8025 .TP
8026 .B use_ipv6
8027 .nf
8028 Type: boolean
8029 Default: yes
8030 .fi
8031 .IP
8032 When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to
8033 contact. If this option is \fIunset\fP, Mutt will restrict itself to IPv4 addresses.
8034 Normally, the default should work.
8035
8036
8037 .TP
8038 .B user_agent
8039 .nf
8040 Type: boolean
8041 Default: no
8042 .fi
8043 .IP
8044 When \fIset\fP, mutt will add a \(lqUser\-Agent:\(rq header to outgoing
8045 messages, indicating which version of mutt was used for composing
8046 them.
8047
8048
8049 .TP
8050 .B visual
8051 .nf
8052 Type: path
8053 Default: \(lq\(rq
8054 .fi
8055 .IP
8056 Specifies the visual editor to invoke when the \(lq\fB~v\fP\(rq command is
8057 given in the built\-in editor.
8058
8059
8060 .TP
8061 .B wait_key
8062 .nf
8063 Type: boolean
8064 Default: yes
8065 .fi
8066 .IP
8067 Controls whether Mutt will ask you to press a key after an external command
8068 has been invoked by these functions: \fB<shell\-escape>\fP,
8069 \fB<pipe\-message>\fP, \fB<pipe\-entry>\fP, \fB<print\-message>\fP,
8070 and \fB<print\-entry>\fP commands.
8071 .IP
8072 It is also used when viewing attachments with \(lqauto_view\(rq, provided
8073 that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
8074 and the external program is interactive.
8075 .IP
8076 When \fIset\fP, Mutt will always ask for a key. When \fIunset\fP, Mutt will wait
8077 for a key only if the external command returned a non\-zero status.
8078
8079
8080 .TP
8081 .B weed
8082 .nf
8083 Type: boolean
8084 Default: yes
8085 .fi
8086 .IP
8087 When \fIset\fP, mutt will weed headers when displaying, forwarding,
8088 or replying to messages.
8089 .IP
8090 Also see $copy_decode_weed, $pipe_decode_weed, $print_decode_weed.
8091
8092
8093 .TP
8094 .B wrap
8095 .nf
8096 Type: number
8097 Default: 0
8098 .fi
8099 .IP
8100 When set to a positive value, mutt will wrap text at $wrap characters.
8101 When set to a negative value, mutt will wrap text so that there are $wrap
8102 characters of empty space on the right side of the terminal. Setting it
8103 to zero makes mutt wrap at the terminal width.
8104 .IP
8105 Also see $reflow_wrap.
8106
8107
8108 .TP
8109 .B wrap_headers
8110 .nf
8111 Type: number
8112 Default: 78
8113 .fi
8114 .IP
8115 This option specifies the number of characters to use for wrapping
8116 an outgoing message's headers. Allowed values are between 78 and 998
8117 inclusive.
8118 .IP
8119 \fBNote:\fP This option usually shouldn't be changed. RFC5233
8120 recommends a line length of 78 (the default), so \fBplease only change
8121 this setting when you know what you're doing\fP.
8122
8123
8124 .TP
8125 .B wrap_search
8126 .nf
8127 Type: boolean
8128 Default: yes
8129 .fi
8130 .IP
8131 Controls whether searches wrap around the end.
8132 .IP
8133 When \fIset\fP, searches will wrap around the first (or last) item. When
8134 \fIunset\fP, incremental searches will not wrap.
8135
8136
8137 .TP
8138 .B wrapmargin
8139 .nf
8140 Type: number
8141 Default: 0
8142 .fi
8143 .IP
8144 (DEPRECATED) Equivalent to setting $wrap with a negative value.
8145
8146
8147 .TP
8148 .B write_bcc
8149 .nf
8150 Type: boolean
8151 Default: no
8152 .fi
8153 .IP
8154 Controls whether mutt writes out the \(lqBcc:\(rq header when
8155 preparing messages to be sent. Some MTAs, such as Exim and
8156 Courier, do not strip the \(lqBcc:\(rq header; so it is advisable to
8157 leave this unset unless you have a particular need for the header
8158 to be in the sent message.
8159 .IP
8160 If mutt is set to deliver directly via SMTP (see $smtp_url),
8161 this option does nothing: mutt will never write out the \(lqBcc:\(rq
8162 header in this case.
8163 .IP
8164 Note this option only affects the sending of messages. Fcc'ed
8165 copies of a message will always contain the \(lqBcc:\(rq header if
8166 one exists.
8167
8168
8169 .TP
8170 .B write_inc
8171 .nf
8172 Type: number
8173 Default: 10
8174 .fi
8175 .IP
8176 When writing a mailbox, a message will be printed every
8177 $write_inc messages to indicate progress. If set to 0, only a
8178 single message will be displayed before writing a mailbox.
8179 .IP
8180 Also see the $read_inc, $net_inc and $time_inc variables and the
8181 \(lqtuning\(rq section of the manual for performance considerations.
8182
8183
8184 .\" -*-nroff-*-
8185 .SH SEE ALSO
8186 .PP
8187 .BR iconv (1),
8188 .BR iconv (3),
8189 .BR mailcap (5),
8190 .BR maildir (5),
8191 .BR mbox (5),
8192 .BR mutt (1),
8193 .BR printf (3),
8194 .BR regex (7),
8195 .BR strftime (3)
8196 .PP
8197 The Mutt Manual
8198 .PP
8199 The Mutt home page: http://www.mutt.org/
8200 .SH AUTHOR
8201 .PP
8202 Michael Elkins, and others. Use <[email protected]> to contact
8203 the developers.