Debian Codegraph @

upstream/debian-unstable/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_servernoise
3388 .nf
3389 Type: boolean
3390 Default: yes
3391 .fi
3392 .IP
3393 When \fIset\fP, mutt will display warning messages from the IMAP
3394 server as error messages. Since these messages are often
3395 harmless, or generated due to configuration problems on the
3396 server which are out of the users' hands, you may wish to suppress
3397 them at some point.
3398
3399
3400 .TP
3401 .B imap_user
3402 .nf
3403 Type: string
3404 Default: \(lq\(rq
3405 .fi
3406 .IP
3407 The name of the user whose mail you intend to access on the IMAP
3408 server.
3409 .IP
3410 This variable defaults to your user name on the local machine.
3411
3412
3413 .TP
3414 .B implicit_autoview
3415 .nf
3416 Type: boolean
3417 Default: no
3418 .fi
3419 .IP
3420 If set to \(lqyes\(rq, mutt will look for a mailcap entry with the
3421 \(lq\fBcopiousoutput\fP\(rq flag set for \fIevery\fP MIME attachment it doesn't have
3422 an internal viewer defined for. If such an entry is found, mutt will
3423 use the viewer defined in that entry to convert the body part to text
3424 form.
3425
3426
3427 .TP
3428 .B include
3429 .nf
3430 Type: quadoption
3431 Default: ask\-yes
3432 .fi
3433 .IP
3434 Controls whether or not a copy of the message(s) you are replying to
3435 is included in your reply.
3436
3437
3438 .TP
3439 .B include_encrypted
3440 .nf
3441 Type: boolean
3442 Default: no
3443 .fi
3444 .IP
3445 Controls whether or not Mutt includes separately encrypted attachment
3446 contents when replying.
3447 .IP
3448 This variable was added to prevent accidental exposure of encrypted
3449 contents when replying to an attacker. If a previously encrypted message
3450 were attached by the attacker, they could trick an unwary recipient into
3451 decrypting and including the message in their reply.
3452
3453
3454 .TP
3455 .B include_onlyfirst
3456 .nf
3457 Type: boolean
3458 Default: no
3459 .fi
3460 .IP
3461 Controls whether or not Mutt includes only the first attachment
3462 of the message you are replying.
3463
3464
3465 .TP
3466 .B indent_string
3467 .nf
3468 Type: string
3469 Default: \(lq> \(rq
3470 .fi
3471 .IP
3472 Specifies the string to prepend to each line of text quoted in a
3473 message to which you are replying. You are strongly encouraged not to
3474 change this value, as it tends to agitate the more fanatical netizens.
3475 .IP
3476 The value of this option is ignored if $text_flowed is set, because
3477 the quoting mechanism is strictly defined for format=flowed.
3478 .IP
3479 This option is a format string, please see the description of
3480 $index_format for supported \fBprintf(3)\fP\-style sequences.
3481
3482
3483 .TP
3484 .B index_format
3485 .nf
3486 Type: string
3487 Default: \(lq%4C %Z %{%b %d} %\-15.15L (%?l?%4l&%4c?) %s\(rq
3488 .fi
3489 .IP
3490 This variable allows you to customize the message index display to
3491 your personal taste.
3492 .IP
3493 \(lqFormat strings\(rq are similar to the strings used in the C
3494 function \fBprintf(3)\fP to format output (see the man page for more details).
3495 For an explanation of the %? construct, see the $status_format description.
3496 The following sequences are defined in Mutt:
3497 .RS
3498 .PD 0
3499 .TP
3500 %a
3501 address of the author
3502 .TP
3503 %A
3504 reply\-to address (if present; otherwise: address of author)
3505 .TP
3506 %b
3507 filename of the original message folder (think mailbox)
3508 .TP
3509 %B
3510 the list to which the letter was sent, or else the folder name (%b).
3511 .TP
3512 %c
3513 number of characters (bytes) in the message (see formatstrings-size)
3514 .TP
3515 %C
3516 current message number
3517 .TP
3518 %d
3519 date and time of the message in the format specified by
3520 $date_format converted to sender's time zone
3521 .TP
3522 %D
3523 date and time of the message in the format specified by
3524 $date_format converted to the local time zone
3525 .TP
3526 %e
3527 current message number in thread
3528 .TP
3529 %E
3530 number of messages in current thread
3531 .TP
3532 %f
3533 sender (address + real name), either From: or Return\-Path:
3534 .TP
3535 %F
3536 author name, or recipient name if the message is from you
3537 .TP
3538 %H
3539 spam attribute(s) of this message
3540 .TP
3541 %i
3542 message\-id of the current message
3543 .TP
3544 %l
3545 number of lines in the unprocessed message (may not work with
3546 maildir, mh, and IMAP folders)
3547 .TP
3548 %L
3549 If an address in the \(lqTo:\(rq or \(lqCc:\(rq header field matches an address
3550 defined by the users \(lqsubscribe\(rq command, this displays
3551 \(rqTo <list\-name>\(rq, otherwise the same as %F.
3552 .TP
3553 %m
3554 total number of message in the mailbox
3555 .TP
3556 %M
3557 number of hidden messages if the thread is collapsed.
3558 .TP
3559 %N
3560 message score
3561 .TP
3562 %n
3563 author's real name (or address if missing)
3564 .TP
3565 %O
3566 original save folder where mutt would formerly have
3567 stashed the message: list name or recipient name
3568 if not sent to a list
3569 .TP
3570 %P
3571 progress indicator for the built\-in pager (how much of the file has been displayed)
3572 .TP
3573 %r
3574 comma separated list of \(lqTo:\(rq recipients
3575 .TP
3576 %R
3577 comma separated list of \(lqCc:\(rq recipients
3578 .TP
3579 %s
3580 subject of the message
3581 .TP
3582 %S
3583 single character status of the message (\(lqN\(rq/\(lqO\(rq/\(lqD\(rq/\(lqd\(rq/\(lq!\(rq/\(lqr\(rq/\(lq*\(rq)
3584 .TP
3585 %t
3586 \(lqTo:\(rq field (recipients)
3587 .TP
3588 %T
3589 the appropriate character from the $to_chars string
3590 .TP
3591 %u
3592 user (login) name of the author
3593 .TP
3594 %v
3595 first name of the author, or the recipient if the message is from you
3596 .TP
3597 %X
3598 number of attachments
3599 (please see the \(lqattachments\(rq section for possible speed effects)
3600 .TP
3601 %y
3602 \(lqX\-Label:\(rq field, if present
3603 .TP
3604 %Y
3605 \(lqX\-Label:\(rq field, if present, and \fI(1)\fP not at part of a thread tree,
3606 \fI(2)\fP at the top of a thread, or \fI(3)\fP \(lqX\-Label:\(rq is different from
3607 preceding message's \(lqX\-Label:\(rq.
3608 .TP
3609 %Z
3610 a three character set of message status flags.
3611 the first character is new/read/replied flags (\(lqn\(rq/\(lqo\(rq/\(lqr\(rq/\(lqO\(rq/\(lqN\(rq).
3612 the second is deleted or encryption flags (\(lqD\(rq/\(lqd\(rq/\(lqS\(rq/\(lqP\(rq/\(lqs\(rq/\(lqK\(rq).
3613 the third is either tagged/flagged (\(lq*\(rq/\(lq!\(rq), or one of the characters
3614 listed in $to_chars.
3615 .TP
3616 %@name@
3617 insert and evaluate format\-string from the matching
3618 \(lqindex-format-hook\(rq command
3619 .TP
3620 %{fmt}
3621 the date and time of the message is converted to sender's
3622 time zone, and \(lqfmt\(rq is expanded by the library function
3623 \fBstrftime(3)\fP; a leading bang disables locales
3624 .TP
3625 %[fmt]
3626 the date and time of the message is converted to the local
3627 time zone, and \(lqfmt\(rq is expanded by the library function
3628 \fBstrftime(3)\fP; a leading bang disables locales
3629 .TP
3630 %(fmt)
3631 the local date and time when the message was received.
3632 \(lqfmt\(rq is expanded by the library function \fBstrftime(3)\fP;
3633 a leading bang disables locales
3634 .TP
3635 %<fmt>
3636 the current local time. \(lqfmt\(rq is expanded by the library
3637 function \fBstrftime(3)\fP; a leading bang disables locales.
3638 .TP
3639 %>X
3640 right justify the rest of the string and pad with character \(lqX\(rq
3641 .TP
3642 %|X
3643 pad to the end of the line with character \(lqX\(rq
3644 .TP
3645 %*X
3646 soft\-fill with character \(lqX\(rq as pad
3647 .RE
3648 .PD 1
3649 .IP
3650 Note that for mbox/mmdf, \(lq%l\(rq applies to the unprocessed message, and
3651 for maildir/mh, the value comes from the \(lqLines:\(rq header field when
3652 present (the meaning is normally the same). Thus the value depends on
3653 the encodings used in the different parts of the message and has little
3654 meaning in practice.
3655 .IP
3656 \(lqSoft\-fill\(rq deserves some explanation: Normal right\-justification
3657 will print everything to the left of the \(lq%>\(rq, displaying padding and
3658 whatever lies to the right only if there's room. By contrast,
3659 soft\-fill gives priority to the right\-hand side, guaranteeing space
3660 to display it and showing padding only if there's still room. If
3661 necessary, soft\-fill will eat text leftwards to make room for
3662 rightward text.
3663 .IP
3664 Note that these expandos are supported in
3665 \(lqsave-hook\(rq, \(lqfcc-hook\(rq, \(lqfcc-save-hook\(rq, and
3666 \(lqindex-format-hook\(rq.
3667 .IP
3668 They are also supported in the configuration variables $attribution,
3669 $forward_attribution_intro, $forward_attribution_trailer,
3670 $forward_format, $indent_string, $message_format, $pager_format,
3671 and $post_indent_string.
3672
3673
3674 .TP
3675 .B ispell
3676 .nf
3677 Type: path
3678 Default: \(lq/usr/bin/ispell\(rq
3679 .fi
3680 .IP
3681 How to invoke ispell (GNU's spell\-checking software).
3682
3683
3684 .TP
3685 .B keep_flagged
3686 .nf
3687 Type: boolean
3688 Default: no
3689 .fi
3690 .IP
3691 If \fIset\fP, read messages marked as flagged will not be moved
3692 from your spool mailbox to your $mbox mailbox, or as a result of
3693 a \(lqmbox-hook\(rq command.
3694
3695
3696 .TP
3697 .B local_date_header
3698 .nf
3699 Type: boolean
3700 Default: yes
3701 .fi
3702 .IP
3703 If \fIset\fP, the date in the Date header of emails that you send will be in
3704 your local timezone. If unset a UTC date will be used instead to avoid
3705 leaking information about your current location.
3706
3707
3708 .TP
3709 .B mail_check
3710 .nf
3711 Type: number
3712 Default: 5
3713 .fi
3714 .IP
3715 This variable configures how often (in seconds) mutt should look for
3716 new mail. Also see the $timeout variable.
3717
3718
3719 .TP
3720 .B mail_check_recent
3721 .nf
3722 Type: boolean
3723 Default: yes
3724 .fi
3725 .IP
3726 When \fIset\fP, Mutt will only notify you about new mail that has been received
3727 since the last time you opened the mailbox. When \fIunset\fP, Mutt will notify you
3728 if any new mail exists in the mailbox, regardless of whether you have visited it
3729 recently.
3730
3731
3732 .TP
3733 .B mail_check_stats
3734 .nf
3735 Type: boolean
3736 Default: no
3737 .fi
3738 .IP
3739 When \fIset\fP, mutt will periodically calculate message
3740 statistics of a mailbox while polling for new mail. It will
3741 check for unread, flagged, and total message counts.
3742 (Note: IMAP mailboxes only support unread and total counts).
3743 .IP
3744 Because this operation is more performance intensive, it defaults
3745 to \fIunset\fP, and has a separate option,
3746 $mail_check_stats_interval, to control how often to update these
3747 counts.
3748 .IP
3749 Message statistics can also be explicitly calculated by invoking the
3750 \fB<check\-stats>\fP
3751 function.
3752
3753
3754 .TP
3755 .B mail_check_stats_interval
3756 .nf
3757 Type: number
3758 Default: 60
3759 .fi
3760 .IP
3761 When $mail_check_stats is \fIset\fP, this variable configures
3762 how often (in seconds) mutt will update message counts.
3763
3764
3765 .TP
3766 .B mailcap_path
3767 .nf
3768 Type: string
3769 Default: \(lq\(rq
3770 .fi
3771 .IP
3772 This variable specifies which files to consult when attempting to
3773 display MIME bodies not directly supported by Mutt. The default value
3774 is generated during startup: see the \(lqmailcap\(rq section of the manual.
3775
3776
3777 .TP
3778 .B mailcap_sanitize
3779 .nf
3780 Type: boolean
3781 Default: yes
3782 .fi
3783 .IP
3784 If \fIset\fP, mutt will restrict possible characters in mailcap % expandos
3785 to a well\-defined set of safe characters. This is the safe setting,
3786 but we are not sure it doesn't break some more advanced MIME stuff.
3787 .IP
3788 \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
3789 DOING!\fP
3790
3791
3792 .TP
3793 .B maildir_header_cache_verify
3794 .nf
3795 Type: boolean
3796 Default: yes
3797 .fi
3798 .IP
3799 Check for Maildir unaware programs other than mutt having modified maildir
3800 files when the header cache is in use. This incurs one \fBstat(2)\fP per
3801 message every time the folder is opened (which can be very slow for NFS
3802 folders).
3803
3804
3805 .TP
3806 .B maildir_trash
3807 .nf
3808 Type: boolean
3809 Default: no
3810 .fi
3811 .IP
3812 If \fIset\fP, messages marked as deleted will be saved with the maildir
3813 trashed flag instead of unlinked. \fBNote:\fP this only applies
3814 to maildir\-style mailboxes. Setting it will have no effect on other
3815 mailbox types.
3816
3817
3818 .TP
3819 .B maildir_check_cur
3820 .nf
3821 Type: boolean
3822 Default: no
3823 .fi
3824 .IP
3825 If \fIset\fP, mutt will poll both the new and cur directories of
3826 a maildir folder for new messages. This might be useful if other
3827 programs interacting with the folder (e.g. dovecot) are moving new
3828 messages to the cur directory. Note that setting this option may
3829 slow down polling for new messages in large folders, since mutt has
3830 to scan all cur messages.
3831
3832
3833 .TP
3834 .B mark_macro_prefix
3835 .nf
3836 Type: string
3837 Default: \(lq'\(rq
3838 .fi
3839 .IP
3840 Prefix for macros created using mark\-message. A new macro
3841 automatically generated with \fI<mark\-message>a\fP will be composed
3842 from this prefix and the letter \fIa\fP.
3843
3844
3845 .TP
3846 .B mark_old
3847 .nf
3848 Type: boolean
3849 Default: yes
3850 .fi
3851 .IP
3852 Controls whether or not mutt marks \fInew\fP \fBunread\fP
3853 messages as \fIold\fP if you exit a mailbox without reading them.
3854 With this option \fIset\fP, the next time you start mutt, the messages
3855 will show up with an \(lqO\(rq next to them in the index menu,
3856 indicating that they are old.
3857
3858
3859 .TP
3860 .B markers
3861 .nf
3862 Type: boolean
3863 Default: yes
3864 .fi
3865 .IP
3866 Controls the display of wrapped lines in the internal pager. If set, a
3867 \(lq+\(rq marker is displayed at the beginning of wrapped lines.
3868 .IP
3869 Also see the $smart_wrap variable.
3870
3871
3872 .TP
3873 .B mask
3874 .nf
3875 Type: regular expression
3876 Default: \(lq!^\\.[^.]\(rq
3877 .fi
3878 .IP
3879 A regular expression used in the file browser, optionally preceded by
3880 the \fInot\fP operator \(lq!\(rq. Only files whose names match this mask
3881 will be shown. The match is always case\-sensitive.
3882
3883
3884 .TP
3885 .B mbox
3886 .nf
3887 Type: path
3888 Default: \(lq~/mbox\(rq
3889 .fi
3890 .IP
3891 This specifies the folder into which read mail in your $spoolfile
3892 folder will be appended.
3893 .IP
3894 Also see the $move variable.
3895
3896
3897 .TP
3898 .B mbox_type
3899 .nf
3900 Type: folder magic
3901 Default: mbox
3902 .fi
3903 .IP
3904 The default mailbox type used when creating new folders. May be any of
3905 \(lqmbox\(rq, \(lqMMDF\(rq, \(lqMH\(rq and \(lqMaildir\(rq. This is overridden by the
3906 \fB\-m\fP command\-line option.
3907
3908
3909 .TP
3910 .B menu_context
3911 .nf
3912 Type: number
3913 Default: 0
3914 .fi
3915 .IP
3916 This variable controls the number of lines of context that are given
3917 when scrolling through menus. (Similar to $pager_context.)
3918
3919
3920 .TP
3921 .B menu_move_off
3922 .nf
3923 Type: boolean
3924 Default: yes
3925 .fi
3926 .IP
3927 When \fIunset\fP, the bottom entry of menus will never scroll up past
3928 the bottom of the screen, unless there are less entries than lines.
3929 When \fIset\fP, the bottom entry may move off the bottom.
3930
3931
3932 .TP
3933 .B menu_scroll
3934 .nf
3935 Type: boolean
3936 Default: no
3937 .fi
3938 .IP
3939 When \fIset\fP, menus will be scrolled up or down one line when you
3940 attempt to move across a screen boundary. If \fIunset\fP, the screen
3941 is cleared and the next or previous page of the menu is displayed
3942 (useful for slow links to avoid many redraws).
3943
3944
3945 .TP
3946 .B message_cache_clean
3947 .nf
3948 Type: boolean
3949 Default: no
3950 .fi
3951 .IP
3952 If \fIset\fP, mutt will clean out obsolete entries from the message cache when
3953 the mailbox is synchronized. You probably only want to set it
3954 every once in a while, since it can be a little slow
3955 (especially for large folders).
3956
3957
3958 .TP
3959 .B message_cachedir
3960 .nf
3961 Type: path
3962 Default: \(lq\(rq
3963 .fi
3964 .IP
3965 Set this to a directory and mutt will cache copies of messages from
3966 your IMAP and POP servers here. You are free to remove entries at any
3967 time.
3968 .IP
3969 When setting this variable to a directory, mutt needs to fetch every
3970 remote message only once and can perform regular expression searches
3971 as fast as for local folders.
3972 .IP
3973 Also see the $message_cache_clean variable.
3974
3975
3976 .TP
3977 .B message_format
3978 .nf
3979 Type: string
3980 Default: \(lq%s\(rq
3981 .fi
3982 .IP
3983 This is the string displayed in the \(lqattachment\(rq menu for
3984 attachments of type \fBmessage/rfc822\fP. For a full listing of defined
3985 \fBprintf(3)\fP\-like sequences see the section on $index_format.
3986
3987
3988 .TP
3989 .B message_id_format
3990 .nf
3991 Type: string
3992 Default: \(lq<%z@%f>\(rq
3993 .fi
3994 .IP
3995 This variable describes the format of the Message\-ID generated
3996 when sending messages. Mutt 2.0 introduced a more compact
3997 format, but this variable allows the ability to choose your own
3998 format. The value may end in \(lq|\(rq to invoke an external filter.
3999 See formatstrings-filters.
4000 .IP
4001 Please note that the Message\-ID value follows a strict syntax,
4002 and you are responsible for ensuring correctness if you change
4003 this from the default. In particular, the value must follow the
4004 syntax in RFC 5322: \(lq\fB\(rq<\(rq id\-left \(rq@\(rq id\-right \(rq>\(rq\fP\(rq. No
4005 spaces are allowed, and \fBid\-left\fP should follow the
4006 dot\-atom\-text syntax in the RFC. The \fBid\-right\fP should
4007 generally be left at %f.
4008 .IP
4009 The old Message\-ID format can be used by setting this to:
4010 \(lq\fB<%Y%02m%02d%02H%02M%02S.G%c%p@%f>\fP\(rq
4011 .IP
4012 The following \fBprintf(3)\fP\-style sequences are understood:
4013 .RS
4014 .PD 0
4015 .TP
4016 %c
4017 step counter looping from \(lqA\(rq to \(lqZ\(rq
4018 .TP
4019 %d
4020 current day of the month (GMT)
4021 .TP
4022 %f
4023 $hostname
4024 .TP
4025 %H
4026 current hour using a 24\-hour clock (GMT)
4027 .TP
4028 %m
4029 current month number (GMT)
4030 .TP
4031 %M
4032 current minute of the hour (GMT)
4033 .TP
4034 %p
4035 pid of the running mutt process
4036 .TP
4037 %r
4038 3 bytes of pseudorandom data encoded in Base64
4039 .TP
4040 %S
4041 current second of the minute (GMT)
4042 .TP
4043 %x
4044 1 byte of pseudorandom data hex encoded (example: '1b')
4045 .TP
4046 %Y
4047 current year using 4 digits (GMT)
4048 .TP
4049 %z
4050 4 byte timestamp + 8 bytes of pseudorandom data encoded in Base64
4051 .RE
4052 .PD 1
4053
4054 .TP
4055 .B meta_key
4056 .nf
4057 Type: boolean
4058 Default: no
4059 .fi
4060 .IP
4061 If \fIset\fP, forces Mutt to interpret keystrokes with the high bit (bit 8)
4062 set as if the user had pressed the Esc key and whatever key remains
4063 after having the high bit removed. For example, if the key pressed
4064 has an ASCII value of \fB0xf8\fP, then this is treated as if the user had
4065 pressed Esc then \(lqx\(rq. This is because the result of removing the
4066 high bit from \fB0xf8\fP is \fB0x78\fP, which is the ASCII character
4067 \(lqx\(rq.
4068
4069
4070 .TP
4071 .B metoo
4072 .nf
4073 Type: boolean
4074 Default: no
4075 .fi
4076 .IP
4077 If \fIunset\fP, Mutt will remove your address (see the \(lqalternates\(rq
4078 command) from the list of recipients when replying to a message.
4079
4080
4081 .TP
4082 .B mh_purge
4083 .nf
4084 Type: boolean
4085 Default: no
4086 .fi
4087 .IP
4088 When \fIunset\fP, mutt will mimic mh's behavior and rename deleted messages
4089 to \fI,<old file name>\fP in mh folders instead of really deleting
4090 them. This leaves the message on disk but makes programs reading the folder
4091 ignore it. If the variable is \fIset\fP, the message files will simply be
4092 deleted.
4093 .IP
4094 This option is similar to $maildir_trash for Maildir folders.
4095
4096
4097 .TP
4098 .B mh_seq_flagged
4099 .nf
4100 Type: string
4101 Default: \(lqflagged\(rq
4102 .fi
4103 .IP
4104 The name of the MH sequence used for flagged messages.
4105
4106
4107 .TP
4108 .B mh_seq_replied
4109 .nf
4110 Type: string
4111 Default: \(lqreplied\(rq
4112 .fi
4113 .IP
4114 The name of the MH sequence used to tag replied messages.
4115
4116
4117 .TP
4118 .B mh_seq_unseen
4119 .nf
4120 Type: string
4121 Default: \(lqunseen\(rq
4122 .fi
4123 .IP
4124 The name of the MH sequence used for unseen messages.
4125
4126
4127 .TP
4128 .B mime_forward
4129 .nf
4130 Type: quadoption
4131 Default: no
4132 .fi
4133 .IP
4134 When \fIset\fP, the message you are forwarding will be attached as a
4135 separate \fBmessage/rfc822\fP MIME part instead of included in the main body of the
4136 message. This is useful for forwarding MIME messages so the receiver
4137 can properly view the message as it was delivered to you. If you like
4138 to switch between MIME and not MIME from mail to mail, set this
4139 variable to \(lqask\-no\(rq or \(lqask\-yes\(rq.
4140 .IP
4141 Also see $forward_decode and $mime_forward_decode.
4142
4143
4144 .TP
4145 .B mime_forward_decode
4146 .nf
4147 Type: boolean
4148 Default: no
4149 .fi
4150 .IP
4151 Controls the decoding of complex MIME messages into \fBtext/plain\fP when
4152 forwarding a message while $mime_forward is \fIset\fP. Otherwise
4153 $forward_decode is used instead.
4154
4155
4156 .TP
4157 .B mime_forward_rest
4158 .nf
4159 Type: quadoption
4160 Default: yes
4161 .fi
4162 .IP
4163 When forwarding multiple attachments of a MIME message from the attachment
4164 menu, attachments which cannot be decoded in a reasonable manner will
4165 be attached to the newly composed message if this option is \fIset\fP.
4166
4167
4168 .TP
4169 .B mime_type_query_command
4170 .nf
4171 Type: string
4172 Default: \(lq\(rq
4173 .fi
4174 .IP
4175 This specifies a command to run, to determine the mime type of a
4176 new attachment when composing a message. Unless
4177 $mime_type_query_first is set, this will only be run if the
4178 attachment's extension is not found in the mime.types file.
4179 .IP
4180 The string may contain a \(lq%s\(rq, which will be substituted with the
4181 attachment filename. Mutt will add quotes around the string substituted
4182 for \(lq%s\(rq automatically according to shell quoting rules, so you should
4183 avoid adding your own. If no \(lq%s\(rq is found in the string, Mutt will
4184 append the attachment filename to the end of the string.
4185 .IP
4186 The command should output a single line containing the
4187 attachment's mime type.
4188 .IP
4189 Suggested values are \(lqxdg\-mime query filetype\(rq or
4190 \(lqfile \-bi\(rq.
4191
4192
4193 .TP
4194 .B mime_type_query_first
4195 .nf
4196 Type: boolean
4197 Default: no
4198 .fi
4199 .IP
4200 When \fIset\fP, the $mime_type_query_command will be run before the
4201 mime.types lookup.
4202
4203
4204 .TP
4205 .B mix_entry_format
4206 .nf
4207 Type: string
4208 Default: \(lq%4n %c %\-16s %a\(rq
4209 .fi
4210 .IP
4211 This variable describes the format of a remailer line on the mixmaster
4212 chain selection screen. The following \fBprintf(3)\fP\-like sequences are
4213 supported:
4214 .RS
4215 .PD 0
4216 .TP
4217 %n
4218 The running number on the menu.
4219 .TP
4220 %c
4221 Remailer capabilities.
4222 .TP
4223 %s
4224 The remailer's short name.
4225 .TP
4226 %a
4227 The remailer's e\-mail address.
4228 .RE
4229 .PD 1
4230 .IP
4231 (Mixmaster only)
4232
4233
4234 .TP
4235 .B mixmaster
4236 .nf
4237 Type: path
4238 Default: \(lqmixmaster\(rq
4239 .fi
4240 .IP
4241 This variable contains the path to the Mixmaster binary on your
4242 system. It is used with various sets of parameters to gather the
4243 list of known remailers, and to finally send a message through the
4244 mixmaster chain. (Mixmaster only)
4245
4246
4247 .TP
4248 .B move
4249 .nf
4250 Type: quadoption
4251 Default: no
4252 .fi
4253 .IP
4254 Controls whether or not Mutt will move read messages
4255 from your spool mailbox to your $mbox mailbox, or as a result of
4256 a \(lqmbox-hook\(rq command.
4257
4258
4259 .TP
4260 .B muttlisp_inline_eval
4261 .nf
4262 Type: boolean
4263 Default: no
4264 .fi
4265 .IP
4266 If \fIset\fP, Mutt will evaluate bare parenthesis arguments to commands
4267 as MuttLisp expressions.
4268
4269
4270 .TP
4271 .B narrow_tree
4272 .nf
4273 Type: boolean
4274 Default: no
4275 .fi
4276 .IP
4277 This variable, when \fIset\fP, makes the thread tree narrower, allowing
4278 deeper threads to fit on the screen.
4279
4280
4281 .TP
4282 .B net_inc
4283 .nf
4284 Type: number
4285 Default: 10
4286 .fi
4287 .IP
4288 Operations that expect to transfer a large amount of data over the
4289 network will update their progress every $net_inc kilobytes.
4290 If set to 0, no progress messages will be displayed.
4291 .IP
4292 See also $read_inc, $write_inc and $net_inc.
4293
4294
4295 .TP
4296 .B new_mail_command
4297 .nf
4298 Type: path
4299 Default: \(lq\(rq
4300 .fi
4301 .IP
4302 If \fIset\fP, Mutt will call this command after a new message is received.
4303 See the $status_format documentation for the values that can be formatted
4304 into this command.
4305
4306
4307 .TP
4308 .B pager
4309 .nf
4310 Type: path
4311 Default: \(lqbuiltin\(rq
4312 .fi
4313 .IP
4314 This variable specifies which pager you would like to use to view
4315 messages. The value \(lqbuiltin\(rq means to use the built\-in pager, otherwise this
4316 variable should specify the pathname of the external pager you would
4317 like to use.
4318 .IP
4319 The string may contain a \(lq%s\(rq, which will be substituted with
4320 the generated message filename. Mutt will add quotes around the
4321 string substituted for \(lq%s\(rq automatically according to shell
4322 quoting rules, so you should avoid adding your own. If no \(lq%s\(rq
4323 is found in the string, Mutt will append the message filename to
4324 the end of the string.
4325 .IP
4326 Using an external pager may have some disadvantages: Additional
4327 keystrokes are necessary because you can't call mutt functions
4328 directly from the pager, and screen resizes cause lines longer than
4329 the screen width to be badly formatted in the help menu.
4330 .IP
4331 When using an external pager, also see $prompt_after which defaults
4332 \fIset\fP.
4333
4334
4335 .TP
4336 .B pager_context
4337 .nf
4338 Type: number
4339 Default: 0
4340 .fi
4341 .IP
4342 This variable controls the number of lines of context that are given
4343 when displaying the next or previous page in the internal pager. By
4344 default, Mutt will display the line after the last one on the screen
4345 at the top of the next page (0 lines of context).
4346 .IP
4347 This variable also specifies the amount of context given for search
4348 results. If positive, this many lines will be given before a match,
4349 if 0, the match will be top\-aligned.
4350
4351
4352 .TP
4353 .B pager_format
4354 .nf
4355 Type: string
4356 Default: \(lq\-%Z\- %C/%m: %\-20.20n %s%* \-\- (%P)\(rq
4357 .fi
4358 .IP
4359 This variable controls the format of the one\-line message \(lqstatus\(rq
4360 displayed before each message in either the internal or an external
4361 pager. The valid sequences are listed in the $index_format
4362 section.
4363
4364
4365 .TP
4366 .B pager_index_lines
4367 .nf
4368 Type: number
4369 Default: 0
4370 .fi
4371 .IP
4372 Determines the number of lines of a mini\-index which is shown when in
4373 the pager. The current message, unless near the top or bottom of the
4374 folder, will be roughly one third of the way down this mini\-index,
4375 giving the reader the context of a few messages before and after the
4376 message. This is useful, for example, to determine how many messages
4377 remain to be read in the current thread. One of the lines is reserved
4378 for the status bar from the index, so a setting of 6
4379 will only show 5 lines of the actual index. A value of 0 results in
4380 no index being shown. If the number of messages in the current folder
4381 is less than $pager_index_lines, then the index will only use as
4382 many lines as it needs.
4383
4384
4385 .TP
4386 .B pager_skip_quoted_context
4387 .nf
4388 Type: number
4389 Default: 0
4390 .fi
4391 .IP
4392 Determines the number of lines of context to show before the
4393 unquoted text when using \fB<skip-quoted>\fP. When set to a
4394 positive number at most that many lines of the previous quote are
4395 displayed. If the previous quote is shorter the whole quote is
4396 displayed.
4397
4398
4399 .TP
4400 .B pager_stop
4401 .nf
4402 Type: boolean
4403 Default: no
4404 .fi
4405 .IP
4406 When \fIset\fP, the internal\-pager will \fBnot\fP move to the next message
4407 when you are at the end of a message and invoke the \fB<next\-page>\fP
4408 function.
4409
4410
4411 .TP
4412 .B pattern_format
4413 .nf
4414 Type: string
4415 Default: \(lq%2n %\-15e %d\(rq
4416 .fi
4417 .IP
4418 This variable describes the format of the \(lqpattern completion\(rq menu. The
4419 following \fBprintf(3)\fP\-style sequences are understood:
4420 .RS
4421 .PD 0
4422 .TP
4423 %d
4424 pattern description
4425 .TP
4426 %e
4427 pattern expression
4428 .TP
4429 %n
4430 index number
4431 .RE
4432 .PD 1
4433 .IP
4434
4435
4436 .TP
4437 .B pgp_auto_decode
4438 .nf
4439 Type: boolean
4440 Default: no
4441 .fi
4442 .IP
4443 If \fIset\fP, mutt will automatically attempt to decrypt traditional PGP
4444 messages whenever the user performs an operation which ordinarily would
4445 result in the contents of the message being operated on. For example,
4446 if the user displays a pgp\-traditional message which has not been manually
4447 checked with the \fB<check-traditional-pgp>\fP function, mutt will automatically
4448 check the message for traditional pgp.
4449
4450
4451 .TP
4452 .B pgp_autoinline
4453 .nf
4454 Type: boolean
4455 Default: no
4456 .fi
4457 .IP
4458 This option controls whether Mutt generates old\-style inline
4459 (traditional) PGP encrypted or signed messages under certain
4460 circumstances. This can be overridden by use of the pgp menu,
4461 when inline is not required. The GPGME backend does not support
4462 this option.
4463 .IP
4464 Note that Mutt might automatically use PGP/MIME for messages
4465 which consist of more than a single MIME part. Mutt can be
4466 configured to ask before sending PGP/MIME messages when inline
4467 (traditional) would not work.
4468 .IP
4469 Also see the $pgp_mime_auto variable.
4470 .IP
4471 Also note that using the old\-style PGP message format is \fBstrongly\fP
4472 \fBdeprecated\fP.
4473 (PGP only)
4474
4475
4476 .TP
4477 .B pgp_check_exit
4478 .nf
4479 Type: boolean
4480 Default: yes
4481 .fi
4482 .IP
4483 If \fIset\fP, mutt will check the exit code of the PGP subprocess when
4484 signing or encrypting. A non\-zero exit code means that the
4485 subprocess failed.
4486 (PGP only)
4487
4488
4489 .TP
4490 .B pgp_check_gpg_decrypt_status_fd
4491 .nf
4492 Type: boolean
4493 Default: yes
4494 .fi
4495 .IP
4496 If \fIset\fP, mutt will check the status file descriptor output
4497 of $pgp_decrypt_command and $pgp_decode_command for GnuPG status codes
4498 indicating successful decryption. This will check for the presence of
4499 DECRYPTION_OKAY, absence of DECRYPTION_FAILED, and that all
4500 PLAINTEXT occurs between the BEGIN_DECRYPTION and END_DECRYPTION
4501 status codes.
4502 .IP
4503 If \fIunset\fP, mutt will instead match the status fd output
4504 against $pgp_decryption_okay.
4505 (PGP only)
4506
4507
4508 .TP
4509 .B pgp_clearsign_command
4510 .nf
4511 Type: string
4512 Default: \(lq\(rq
4513 .fi
4514 .IP
4515 This format is used to create an old\-style \(lqclearsigned\(rq PGP
4516 message. Note that the use of this format is \fBstrongly\fP
4517 \fBdeprecated\fP.
4518 .IP
4519 This is a format string, see the $pgp_decode_command command for
4520 possible \fBprintf(3)\fP\-like sequences.
4521 (PGP only)
4522
4523
4524 .TP
4525 .B pgp_decode_command
4526 .nf
4527 Type: string
4528 Default: \(lq\(rq
4529 .fi
4530 .IP
4531 This format strings specifies a command which is used to decode
4532 application/pgp attachments.
4533 .IP
4534 The PGP command formats have their own set of \fBprintf(3)\fP\-like sequences:
4535 .RS
4536 .PD 0
4537 .TP
4538 %p
4539 Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
4540 string otherwise. Note: This may be used with a %? construct.
4541 .TP
4542 %f
4543 Expands to the name of a file containing a message.
4544 .TP
4545 %s
4546 Expands to the name of a file containing the signature part
4547 of a \fBmultipart/signed\fP attachment when verifying it.
4548 .TP
4549 %a
4550 The value of $pgp_sign_as if set, otherwise the value
4551 of $pgp_default_key.
4552 .TP
4553 %r
4554 One or more key IDs (or fingerprints if available).
4555 .RE
4556 .PD 1
4557 .IP
4558 For examples on how to configure these formats for the various versions
4559 of PGP which are floating around, see the pgp and gpg sample configuration files in
4560 the \fBsamples/\fP subdirectory which has been installed on your system
4561 alongside the documentation.
4562 (PGP only)
4563
4564
4565 .TP
4566 .B pgp_decrypt_command
4567 .nf
4568 Type: string
4569 Default: \(lq\(rq
4570 .fi
4571 .IP
4572 This command is used to decrypt a PGP encrypted message.
4573 .IP
4574 This is a format string, see the $pgp_decode_command command for
4575 possible \fBprintf(3)\fP\-like sequences.
4576 (PGP only)
4577
4578
4579 .TP
4580 .B pgp_decryption_okay
4581 .nf
4582 Type: regular expression
4583 Default: \(lq\(rq
4584 .fi
4585 .IP
4586 If you assign text to this variable, then an encrypted PGP
4587 message is only considered successfully decrypted if the output
4588 from $pgp_decrypt_command contains the text. This is used to
4589 protect against a spoofed encrypted message, with multipart/encrypted
4590 headers but containing a block that is not actually encrypted.
4591 (e.g. simply signed and ascii armored text).
4592 .IP
4593 Note that if $pgp_check_gpg_decrypt_status_fd is set, this variable
4594 is ignored.
4595 (PGP only)
4596
4597
4598 .TP
4599 .B pgp_default_key
4600 .nf
4601 Type: string
4602 Default: \(lq\(rq
4603 .fi
4604 .IP
4605 This is the default key\-pair to use for PGP operations. It will be
4606 used for encryption (see $postpone_encrypt and $pgp_self_encrypt).
4607 .IP
4608 It will also be used for signing unless $pgp_sign_as is set.
4609 .IP
4610 The (now deprecated) \fIpgp_self_encrypt_as\fP is an alias for this
4611 variable, and should no longer be used.
4612 (PGP only)
4613
4614
4615 .TP
4616 .B pgp_encrypt_only_command
4617 .nf
4618 Type: string
4619 Default: \(lq\(rq
4620 .fi
4621 .IP
4622 This command is used to encrypt a body part without signing it.
4623 .IP
4624 This is a format string, see the $pgp_decode_command command for
4625 possible \fBprintf(3)\fP\-like sequences.
4626 (PGP only)
4627
4628
4629 .TP
4630 .B pgp_encrypt_sign_command
4631 .nf
4632 Type: string
4633 Default: \(lq\(rq
4634 .fi
4635 .IP
4636 This command is used to both sign and encrypt a body part.
4637 .IP
4638 This is a format string, see the $pgp_decode_command command for
4639 possible \fBprintf(3)\fP\-like sequences.
4640 (PGP only)
4641
4642
4643 .TP
4644 .B pgp_entry_format
4645 .nf
4646 Type: string
4647 Default: \(lq%4n %t%f %4l/0x%k %\-4a %2c %u\(rq
4648 .fi
4649 .IP
4650 This variable allows you to customize the PGP key selection menu to
4651 your personal taste. This string is similar to $index_format, but
4652 has its own set of \fBprintf(3)\fP\-like sequences:
4653 .RS
4654 .PD 0
4655 .TP
4656 %n
4657 number
4658 .TP
4659 %k
4660 key id
4661 .TP
4662 %u
4663 user id
4664 .TP
4665 %a
4666 algorithm
4667 .TP
4668 %l
4669 key length
4670 .TP
4671 %f
4672 flags
4673 .TP
4674 %c
4675 capabilities
4676 .TP
4677 %t
4678 trust/validity of the key\-uid association
4679 .TP
4680 %[<s>]
4681 date of the key where <s> is an \fBstrftime(3)\fP expression
4682 .RE
4683 .PD 1
4684 .IP
4685 (PGP only)
4686
4687
4688 .TP
4689 .B pgp_export_command
4690 .nf
4691 Type: string
4692 Default: \(lq\(rq
4693 .fi
4694 .IP
4695 This command is used to export a public key from the user's
4696 key ring.
4697 .IP
4698 This is a format string, see the $pgp_decode_command command for
4699 possible \fBprintf(3)\fP\-like sequences.
4700 (PGP only)
4701
4702
4703 .TP
4704 .B pgp_getkeys_command
4705 .nf
4706 Type: string
4707 Default: \(lq\(rq
4708 .fi
4709 .IP
4710 This command is invoked whenever Mutt needs to fetch the public key associated with
4711 an email address. Of the sequences supported by $pgp_decode_command, %r is
4712 the only \fBprintf(3)\fP\-like sequence used with this format. Note that
4713 in this case, %r expands to the email address, not the public key ID (the key ID is
4714 unknown, which is why Mutt is invoking this command).
4715 (PGP only)
4716
4717
4718 .TP
4719 .B pgp_good_sign
4720 .nf
4721 Type: regular expression
4722 Default: \(lq\(rq
4723 .fi
4724 .IP
4725 If you assign a text to this variable, then a PGP signature is only
4726 considered verified if the output from $pgp_verify_command contains
4727 the text. Use this variable if the exit code from the command is 0
4728 even for bad signatures.
4729 (PGP only)
4730
4731
4732 .TP
4733 .B pgp_ignore_subkeys
4734 .nf
4735 Type: boolean
4736 Default: yes
4737 .fi
4738 .IP
4739 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
4740 the principal key will inherit the subkeys' capabilities. \fIUnset\fP this
4741 if you want to play interesting key selection games.
4742 (PGP only)
4743
4744
4745 .TP
4746 .B pgp_import_command
4747 .nf
4748 Type: string
4749 Default: \(lq\(rq
4750 .fi
4751 .IP
4752 This command is used to import a key from a message into
4753 the user's public key ring.
4754 .IP
4755 This is a format string, see the $pgp_decode_command command for
4756 possible \fBprintf(3)\fP\-like sequences.
4757 (PGP only)
4758
4759
4760 .TP
4761 .B pgp_list_pubring_command
4762 .nf
4763 Type: string
4764 Default: \(lq\(rq
4765 .fi
4766 .IP
4767 This command is used to list the public key ring's contents. The
4768 output format must be analogous to the one used by
4769
4770 .IP
4771 .EX
4772 gpg \-\-list\-keys \-\-with\-colons \-\-with\-fingerprint
4773
4774 .EE
4775 .IP
4776 This format is also generated by the \fBmutt_pgpring\fP utility which comes
4777 with mutt.
4778 .IP
4779 Note: gpg's \fBfixed\-list\-mode\fP option should not be used. It
4780 produces a different date format which may result in mutt showing
4781 incorrect key generation dates.
4782 .IP
4783 This is a format string, see the $pgp_decode_command command for
4784 possible \fBprintf(3)\fP\-like sequences.
4785 Note that in this case, %r expands to the search string, which is a list of
4786 one or more quoted values such as email address, name, or keyid.
4787 (PGP only)
4788
4789
4790 .TP
4791 .B pgp_list_secring_command
4792 .nf
4793 Type: string
4794 Default: \(lq\(rq
4795 .fi
4796 .IP
4797 This command is used to list the secret key ring's contents. The
4798 output format must be analogous to the one used by:
4799
4800 .IP
4801 .EX
4802 gpg \-\-list\-keys \-\-with\-colons \-\-with\-fingerprint
4803
4804 .EE
4805 .IP
4806 This format is also generated by the \fBmutt_pgpring\fP utility which comes
4807 with mutt.
4808 .IP
4809 Note: gpg's \fBfixed\-list\-mode\fP option should not be used. It
4810 produces a different date format which may result in mutt showing
4811 incorrect key generation dates.
4812 .IP
4813 This is a format string, see the $pgp_decode_command command for
4814 possible \fBprintf(3)\fP\-like sequences.
4815 Note that in this case, %r expands to the search string, which is a list of
4816 one or more quoted values such as email address, name, or keyid.
4817 (PGP only)
4818
4819
4820 .TP
4821 .B pgp_long_ids
4822 .nf
4823 Type: boolean
4824 Default: yes
4825 .fi
4826 .IP
4827 If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs.
4828 NOTE: Internally, Mutt has transitioned to using fingerprints (or long key IDs
4829 as a fallback). This option now only controls the display of key IDs
4830 in the key selection menu and a few other places.
4831 (PGP only)
4832
4833
4834 .TP
4835 .B pgp_mime_auto
4836 .nf
4837 Type: quadoption
4838 Default: ask\-yes
4839 .fi
4840 .IP
4841 This option controls whether Mutt will prompt you for
4842 automatically sending a (signed/encrypted) message using
4843 PGP/MIME when inline (traditional) fails (for any reason).
4844 .IP
4845 Also note that using the old\-style PGP message format is \fBstrongly\fP
4846 \fBdeprecated\fP.
4847 (PGP only)
4848
4849
4850 .TP
4851 .B pgp_replyinline
4852 .nf
4853 Type: boolean
4854 Default: no
4855 .fi
4856 .IP
4857 Setting this variable will cause Mutt to always attempt to
4858 create an inline (traditional) message when replying to a
4859 message which is PGP encrypted/signed inline. This can be
4860 overridden by use of the pgp menu, when inline is not
4861 required. This option does not automatically detect if the
4862 (replied\-to) message is inline; instead it relies on Mutt
4863 internals for previously checked/flagged messages.
4864 .IP
4865 Note that Mutt might automatically use PGP/MIME for messages
4866 which consist of more than a single MIME part. Mutt can be
4867 configured to ask before sending PGP/MIME messages when inline
4868 (traditional) would not work.
4869 .IP
4870 Also see the $pgp_mime_auto variable.
4871 .IP
4872 Also note that using the old\-style PGP message format is \fBstrongly\fP
4873 \fBdeprecated\fP.
4874 (PGP only)
4875
4876
4877 .TP
4878 .B pgp_retainable_sigs
4879 .nf
4880 Type: boolean
4881 Default: no
4882 .fi
4883 .IP
4884 If \fIset\fP, signed and encrypted messages will consist of nested
4885 \fBmultipart/signed\fP and \fBmultipart/encrypted\fP body parts.
4886 .IP
4887 This is useful for applications like encrypted and signed mailing
4888 lists, where the outer layer (\fBmultipart/encrypted\fP) can be easily
4889 removed, while the inner \fBmultipart/signed\fP part is retained.
4890 (PGP only)
4891
4892
4893 .TP
4894 .B pgp_self_encrypt
4895 .nf
4896 Type: boolean
4897 Default: yes
4898 .fi
4899 .IP
4900 When \fIset\fP, PGP encrypted messages will also be encrypted
4901 using the key in $pgp_default_key.
4902 (PGP only)
4903
4904
4905 .TP
4906 .B pgp_show_unusable
4907 .nf
4908 Type: boolean
4909 Default: yes
4910 .fi
4911 .IP
4912 If \fIset\fP, mutt will display non\-usable keys on the PGP key selection
4913 menu. This includes keys which have been revoked, have expired, or
4914 have been marked as \(lqdisabled\(rq by the user.
4915 (PGP only)
4916
4917
4918 .TP
4919 .B pgp_sign_as
4920 .nf
4921 Type: string
4922 Default: \(lq\(rq
4923 .fi
4924 .IP
4925 If you have a different key pair to use for signing, you should
4926 set this to the signing key. Most people will only need to set
4927 $pgp_default_key. It is recommended that you use the keyid form
4928 to specify your key (e.g. \fB0x00112233\fP).
4929 (PGP only)
4930
4931
4932 .TP
4933 .B pgp_sign_command
4934 .nf
4935 Type: string
4936 Default: \(lq\(rq
4937 .fi
4938 .IP
4939 This command is used to create the detached PGP signature for a
4940 \fBmultipart/signed\fP PGP/MIME body part.
4941 .IP
4942 This is a format string, see the $pgp_decode_command command for
4943 possible \fBprintf(3)\fP\-like sequences.
4944 (PGP only)
4945
4946
4947 .TP
4948 .B pgp_sort_keys
4949 .nf
4950 Type: sort order
4951 Default: address
4952 .fi
4953 .IP
4954 Specifies how the entries in the pgp menu are sorted. The
4955 following are legal values:
4956 .RS
4957 .PD 0
4958 .TP
4959 address
4960 sort alphabetically by user id
4961 .TP
4962 keyid
4963 sort alphabetically by key id
4964 .TP
4965 date
4966 sort by key creation date
4967 .TP
4968 trust
4969 sort by the trust of the key
4970 .RE
4971 .PD 1
4972 .IP
4973 If you prefer reverse order of the above values, prefix it with
4974 \(lqreverse\-\(rq.
4975 (PGP only)
4976
4977
4978 .TP
4979 .B pgp_strict_enc
4980 .nf
4981 Type: boolean
4982 Default: yes
4983 .fi
4984 .IP
4985 If \fIset\fP, Mutt will automatically encode PGP/MIME signed messages as
4986 quoted\-printable. Please note that unsetting this variable may
4987 lead to problems with non\-verifyable PGP signatures, so only change
4988 this if you know what you are doing.
4989 (PGP only)
4990
4991
4992 .TP
4993 .B pgp_timeout
4994 .nf
4995 Type: number (long)
4996 Default: 300
4997 .fi
4998 .IP
4999 The number of seconds after which a cached passphrase will expire if
5000 not used.
5001 (PGP only)
5002
5003
5004 .TP
5005 .B pgp_use_gpg_agent
5006 .nf
5007 Type: boolean
5008 Default: yes
5009 .fi
5010 .IP
5011 If \fIset\fP, mutt expects a \fBgpg\-agent(1)\fP process will handle
5012 private key passphrase prompts. If \fIunset\fP, mutt will prompt
5013 for the passphrase and pass it via stdin to the pgp command.
5014 .IP
5015 Note that as of version 2.1, GnuPG automatically spawns an agent
5016 and requires the agent be used for passphrase management. Since
5017 that version is increasingly prevalent, this variable now
5018 defaults \fIset\fP.
5019 .IP
5020 Mutt works with a GUI or curses pinentry program. A TTY pinentry
5021 should not be used.
5022 .IP
5023 If you are using an older version of GnuPG without an agent running,
5024 or another encryption program without an agent, you will need to
5025 \fIunset\fP this variable.
5026 (PGP only)
5027
5028
5029 .TP
5030 .B pgp_verify_command
5031 .nf
5032 Type: string
5033 Default: \(lq\(rq
5034 .fi
5035 .IP
5036 This command is used to verify PGP signatures.
5037 .IP
5038 This is a format string, see the $pgp_decode_command command for
5039 possible \fBprintf(3)\fP\-like sequences.
5040 (PGP only)
5041
5042
5043 .TP
5044 .B pgp_verify_key_command
5045 .nf
5046 Type: string
5047 Default: \(lq\(rq
5048 .fi
5049 .IP
5050 This command is used to verify key information from the key selection
5051 menu.
5052 .IP
5053 This is a format string, see the $pgp_decode_command command for
5054 possible \fBprintf(3)\fP\-like sequences.
5055 (PGP only)
5056
5057
5058 .TP
5059 .B pipe_decode
5060 .nf
5061 Type: boolean
5062 Default: no
5063 .fi
5064 .IP
5065 Used in connection with the \fB<pipe\-message>\fP function. When \fIunset\fP,
5066 Mutt will pipe the messages without any preprocessing. When \fIset\fP, Mutt
5067 will attempt to decode the messages first.
5068 .IP
5069 Also see $pipe_decode_weed, which controls whether headers will
5070 be weeded when this is \fIset\fP.
5071
5072
5073 .TP
5074 .B pipe_decode_weed
5075 .nf
5076 Type: boolean
5077 Default: yes
5078 .fi
5079 .IP
5080 For \fB<pipe\-message>\fP, when $pipe_decode is set, this further
5081 controls whether Mutt will weed headers.
5082
5083
5084 .TP
5085 .B pipe_sep
5086 .nf
5087 Type: string
5088 Default: \(lq\\n\(rq
5089 .fi
5090 .IP
5091 The separator to add between messages when piping a list of tagged
5092 messages to an external Unix command.
5093
5094
5095 .TP
5096 .B pipe_split
5097 .nf
5098 Type: boolean
5099 Default: no
5100 .fi
5101 .IP
5102 Used in connection with the \fB<pipe\-message>\fP function following
5103 \fB<tag\-prefix>\fP. If this variable is \fIunset\fP, when piping a list of
5104 tagged messages Mutt will concatenate the messages and will pipe them
5105 all concatenated. When \fIset\fP, Mutt will pipe the messages one by one.
5106 In both cases the messages are piped in the current sorted order,
5107 and the $pipe_sep separator is added after each message.
5108
5109
5110 .TP
5111 .B pop_auth_try_all
5112 .nf
5113 Type: boolean
5114 Default: yes
5115 .fi
5116 .IP
5117 If \fIset\fP, Mutt will try all available authentication methods.
5118 When \fIunset\fP, Mutt will only fall back to other authentication
5119 methods if the previous methods are unavailable. If a method is
5120 available but authentication fails, Mutt will not connect to the POP server.
5121
5122
5123 .TP
5124 .B pop_authenticators
5125 .nf
5126 Type: string
5127 Default: \(lq\(rq
5128 .fi
5129 .IP
5130 This is a colon\-delimited list of authentication methods mutt may
5131 attempt to use to log in to an POP server, in the order mutt should
5132 try them. Authentication methods are either \(lquser\(rq, \(lqapop\(rq or any
5133 SASL mechanism, e.g. \(lqdigest\-md5\(rq, \(lqgssapi\(rq or \(lqcram\-md5\(rq.
5134 This option is case\-insensitive. If this option is \fIunset\fP
5135 (the default) mutt will try all available methods, in order from
5136 most\-secure to least\-secure.
5137 .IP
5138 Example:
5139
5140 .IP
5141 .EX
5142 set pop_authenticators=\(rqdigest\-md5:apop:user\(rq
5143
5144 .EE
5145
5146
5147 .TP
5148 .B pop_checkinterval
5149 .nf
5150 Type: number
5151 Default: 60
5152 .fi
5153 .IP
5154 This variable configures how often (in seconds) mutt should look for
5155 new mail in the currently selected mailbox if it is a POP mailbox.
5156
5157
5158 .TP
5159 .B pop_delete
5160 .nf
5161 Type: quadoption
5162 Default: ask\-no
5163 .fi
5164 .IP
5165 If \fIset\fP, Mutt will delete successfully downloaded messages from the POP
5166 server when using the \fB<fetch-mail>\fP function. When \fIunset\fP, Mutt will
5167 download messages but also leave them on the POP server.
5168
5169
5170 .TP
5171 .B pop_host
5172 .nf
5173 Type: string
5174 Default: \(lq\(rq
5175 .fi
5176 .IP
5177 The name of your POP server for the \fB<fetch-mail>\fP function. You
5178 can also specify an alternative port, username and password, i.e.:
5179
5180 .IP
5181 .EX
5182 [pop[s]://][username[:password]@]popserver[:port]
5183
5184 .EE
5185 .IP
5186 where \(lq[...]\(rq denotes an optional part.
5187
5188
5189 .TP
5190 .B pop_last
5191 .nf
5192 Type: boolean
5193 Default: no
5194 .fi
5195 .IP
5196 If this variable is \fIset\fP, mutt will try to use the \(lq\fBLAST\fP\(rq POP command
5197 for retrieving only unread messages from the POP server when using
5198 the \fB<fetch-mail>\fP function.
5199
5200
5201 .TP
5202 .B pop_oauth_refresh_command
5203 .nf
5204 Type: string
5205 Default: \(lq\(rq
5206 .fi
5207 .IP
5208 The command to run to generate an OAUTH refresh token for
5209 authorizing your connection to your POP server. This command will be
5210 run on every connection attempt that uses the OAUTHBEARER authentication
5211 mechanism. See \(lqoauth\(rq for details.
5212
5213
5214 .TP
5215 .B pop_pass
5216 .nf
5217 Type: string
5218 Default: \(lq\(rq
5219 .fi
5220 .IP
5221 Specifies the password for your POP account. If \fIunset\fP, Mutt will
5222 prompt you for your password when you open a POP mailbox.
5223 .IP
5224 \fBWarning\fP: you should only use this option when you are on a
5225 fairly secure machine, because the superuser can read your muttrc
5226 even if you are the only one who can read the file.
5227
5228
5229 .TP
5230 .B pop_reconnect
5231 .nf
5232 Type: quadoption
5233 Default: ask\-yes
5234 .fi
5235 .IP
5236 Controls whether or not Mutt will try to reconnect to the POP server if
5237 the connection is lost.
5238
5239
5240 .TP
5241 .B pop_user
5242 .nf
5243 Type: string
5244 Default: \(lq\(rq
5245 .fi
5246 .IP
5247 Your login name on the POP server.
5248 .IP
5249 This variable defaults to your user name on the local machine.
5250
5251
5252 .TP
5253 .B post_indent_string
5254 .nf
5255 Type: string
5256 Default: \(lq\(rq
5257 .fi
5258 .IP
5259 Similar to the $attribution variable, Mutt will append this
5260 string after the inclusion of a message which is being replied to.
5261 For a full listing of defined \fBprintf(3)\fP\-like sequences see
5262 the section on $index_format.
5263
5264
5265 .TP
5266 .B postpone
5267 .nf
5268 Type: quadoption
5269 Default: ask\-yes
5270 .fi
5271 .IP
5272 Controls whether or not messages are saved in the $postponed
5273 mailbox when you elect not to send immediately.
5274 .IP
5275 Also see the $recall variable.
5276
5277
5278 .TP
5279 .B postponed
5280 .nf
5281 Type: path
5282 Default: \(lq~/postponed\(rq
5283 .fi
5284 .IP
5285 Mutt allows you to indefinitely \(lqpostpone sending a message\(rq which
5286 you are editing. When you choose to postpone a message, Mutt saves it
5287 in the mailbox specified by this variable.
5288 .IP
5289 Also see the $postpone variable.
5290
5291
5292 .TP
5293 .B postpone_encrypt
5294 .nf
5295 Type: boolean
5296 Default: no
5297 .fi
5298 .IP
5299 When \fIset\fP, postponed messages that are marked for encryption will be
5300 self\-encrypted. Mutt will first try to encrypt using the value specified
5301 in $pgp_default_key or $smime_default_key. If those are not
5302 set, it will try the deprecated $postpone_encrypt_as.
5303 (Crypto only)
5304
5305
5306 .TP
5307 .B postpone_encrypt_as
5308 .nf
5309 Type: string
5310 Default: \(lq\(rq
5311 .fi
5312 .IP
5313 This is a deprecated fall\-back variable for $postpone_encrypt.
5314 Please use $pgp_default_key or $smime_default_key.
5315 (Crypto only)
5316
5317
5318 .TP
5319 .B preconnect
5320 .nf
5321 Type: string
5322 Default: \(lq\(rq
5323 .fi
5324 .IP
5325 If \fIset\fP, a shell command to be executed if mutt fails to establish
5326 a connection to the server. This is useful for setting up secure
5327 connections, e.g. with \fBssh(1)\fP. If the command returns a nonzero
5328 status, mutt gives up opening the server. Example:
5329
5330 .IP
5331 .EX
5332 set preconnect=\(rqssh \-f \-q \-L 1234:mailhost.net:143 mailhost.net \\
5333 sleep 20 < /dev/null > /dev/null\(rq
5334
5335 .EE
5336 .IP
5337 Mailbox \(lqfoo\(rq on \(lqmailhost.net\(rq can now be reached
5338 as \(lq{localhost:1234}foo\(rq.
5339 .IP
5340 Note: For this example to work, you must be able to log in to the
5341 remote machine without having to enter a password.
5342
5343
5344 .TP
5345 .B print
5346 .nf
5347 Type: quadoption
5348 Default: ask\-no
5349 .fi
5350 .IP
5351 Controls whether or not Mutt really prints messages.
5352 This is set to \(lqask\-no\(rq by default, because some people
5353 accidentally hit \(lqp\(rq often.
5354
5355
5356 .TP
5357 .B print_command
5358 .nf
5359 Type: path
5360 Default: \(lqlpr\(rq
5361 .fi
5362 .IP
5363 This specifies the command pipe that should be used to print messages.
5364
5365
5366 .TP
5367 .B print_decode
5368 .nf
5369 Type: boolean
5370 Default: yes
5371 .fi
5372 .IP
5373 Used in connection with the \fB<print\-message>\fP function. If this
5374 option is \fIset\fP, the message is decoded before it is passed to the
5375 external command specified by $print_command. If this option
5376 is \fIunset\fP, no processing will be applied to the message when
5377 printing it. The latter setting may be useful if you are using
5378 some advanced printer filter which is able to properly format
5379 e\-mail messages for printing.
5380 .IP
5381 Also see $print_decode_weed, which controls whether headers will
5382 be weeded when this is \fIset\fP.
5383
5384
5385 .TP
5386 .B print_decode_weed
5387 .nf
5388 Type: boolean
5389 Default: yes
5390 .fi
5391 .IP
5392 For \fB<print\-message>\fP, when $print_decode is set, this
5393 further controls whether Mutt will weed headers.
5394
5395
5396 .TP
5397 .B print_split
5398 .nf
5399 Type: boolean
5400 Default: no
5401 .fi
5402 .IP
5403 Used in connection with the \fB<print\-message>\fP function. If this option
5404 is \fIset\fP, the command specified by $print_command is executed once for
5405 each message which is to be printed. If this option is \fIunset\fP,
5406 the command specified by $print_command is executed only once, and
5407 all the messages are concatenated, with a form feed as the message
5408 separator.
5409 .IP
5410 Those who use the \fBenscript\fP(1) program's mail\-printing mode will
5411 most likely want to \fIset\fP this option.
5412
5413
5414 .TP
5415 .B prompt_after
5416 .nf
5417 Type: boolean
5418 Default: yes
5419 .fi
5420 .IP
5421 If you use an \fIexternal\fP $pager, setting this variable will
5422 cause Mutt to prompt you for a command when the pager exits rather
5423 than returning to the index menu. If \fIunset\fP, Mutt will return to the
5424 index menu when the external pager exits.
5425
5426
5427 .TP
5428 .B query_command
5429 .nf
5430 Type: path
5431 Default: \(lq\(rq
5432 .fi
5433 .IP
5434 This specifies the command Mutt will use to make external address
5435 queries. The string may contain a \(lq%s\(rq, which will be substituted
5436 with the query string the user types. Mutt will add quotes around the
5437 string substituted for \(lq%s\(rq automatically according to shell quoting
5438 rules, so you should avoid adding your own. If no \(lq%s\(rq is found in
5439 the string, Mutt will append the user's query to the end of the string.
5440 See \(lqquery\(rq for more information.
5441
5442
5443 .TP
5444 .B query_format
5445 .nf
5446 Type: string
5447 Default: \(lq%4c %t %\-25.25a %\-25.25n %?e?(%e)?\(rq
5448 .fi
5449 .IP
5450 This variable describes the format of the \(lqquery\(rq menu. The
5451 following \fBprintf(3)\fP\-style sequences are understood:
5452 .RS
5453 .PD 0
5454 .TP
5455 %a
5456 destination address
5457 .TP
5458 %c
5459 current entry number
5460 .TP
5461 %e
5462 extra information *
5463 .TP
5464 %n
5465 destination name
5466 .TP
5467 %t
5468 \(lq*\(rq if current entry is tagged, a space otherwise
5469 .TP
5470 %>X
5471 right justify the rest of the string and pad with \(lqX\(rq
5472 .TP
5473 %|X
5474 pad to the end of the line with \(lqX\(rq
5475 .TP
5476 %*X
5477 soft\-fill with character \(lqX\(rq as pad
5478 .RE
5479 .PD 1
5480 .IP
5481 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
5482 .IP
5483 * = can be optionally printed if nonzero, see the $status_format documentation.
5484
5485
5486 .TP
5487 .B quit
5488 .nf
5489 Type: quadoption
5490 Default: yes
5491 .fi
5492 .IP
5493 This variable controls whether \(lqquit\(rq and \(lqexit\(rq actually quit
5494 from mutt. If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they
5495 have no effect, and if it is set to \fIask\-yes\fP or \fIask\-no\fP, you are
5496 prompted for confirmation when you try to quit.
5497
5498
5499 .TP
5500 .B quote_regexp
5501 .nf
5502 Type: regular expression
5503 Default: \(lq^([ \\t]*[|>:}#])+\(rq
5504 .fi
5505 .IP
5506 A regular expression used in the internal pager to determine quoted
5507 sections of text in the body of a message. Quoted text may be filtered
5508 out using the \fB<toggle\-quoted>\fP command, or colored according to the
5509 \(lqcolor quoted\(rq family of directives.
5510 .IP
5511 Higher levels of quoting may be colored differently (\(lqcolor quoted1\(rq,
5512 \(lqcolor quoted2\(rq, etc.). The quoting level is determined by removing
5513 the last character from the matched text and recursively reapplying
5514 the regular expression until it fails to produce a match.
5515 .IP
5516 Match detection may be overridden by the $smileys regular expression.
5517
5518
5519 .TP
5520 .B read_inc
5521 .nf
5522 Type: number
5523 Default: 10
5524 .fi
5525 .IP
5526 If set to a value greater than 0, Mutt will display which message it
5527 is currently on when reading a mailbox or when performing search actions
5528 such as search and limit. The message is printed after
5529 this many messages have been read or searched (e.g., if set to 25, Mutt will
5530 print a message when it is at message 25, and then again when it gets
5531 to message 50). This variable is meant to indicate progress when
5532 reading or searching large mailboxes which may take some time.
5533 When set to 0, only a single message will appear before the reading
5534 the mailbox.
5535 .IP
5536 Also see the $write_inc, $net_inc and $time_inc variables and the
5537 \(lqtuning\(rq section of the manual for performance considerations.
5538
5539
5540 .TP
5541 .B read_only
5542 .nf
5543 Type: boolean
5544 Default: no
5545 .fi
5546 .IP
5547 If \fIset\fP, all folders are opened in read\-only mode.
5548
5549
5550 .TP
5551 .B realname
5552 .nf
5553 Type: string
5554 Default: \(lq\(rq
5555 .fi
5556 .IP
5557 This variable specifies what \(lqreal\(rq or \(lqpersonal\(rq name should be used
5558 when sending messages.
5559 .IP
5560 By default, this is the GECOS field from \fB/etc/passwd\fP. Note that this
5561 variable will \fInot\fP be used when the user has set a real name
5562 in the $from variable.
5563
5564
5565 .TP
5566 .B recall
5567 .nf
5568 Type: quadoption
5569 Default: ask\-yes
5570 .fi
5571 .IP
5572 Controls whether or not Mutt recalls postponed messages
5573 when composing a new message.
5574 .IP
5575 Setting this variable to \fIyes\fP is not generally useful, and thus not
5576 recommended. Note that the \fB<recall\-message>\fP function can be used
5577 to manually recall postponed messages.
5578 .IP
5579 Also see $postponed variable.
5580
5581
5582 .TP
5583 .B record
5584 .nf
5585 Type: path
5586 Default: \(lq~/sent\(rq
5587 .fi
5588 .IP
5589 This specifies the file into which your outgoing messages should be
5590 appended. (This is meant as the primary method for saving a copy of
5591 your messages, but another way to do this is using the \(lqmy_hdr\(rq
5592 command to create a \(lqBcc:\(rq field with your email address in it.)
5593 .IP
5594 The value of \fI$record\fP is overridden by the $force_name and
5595 $save_name variables, and the \(lqfcc-hook\(rq command. Also see $copy
5596 and $write_bcc.
5597 .IP
5598 Multiple mailboxes may be specified if $fcc_delimiter is
5599 set to a string delimiter.
5600
5601
5602 .TP
5603 .B reflow_space_quotes
5604 .nf
5605 Type: boolean
5606 Default: yes
5607 .fi
5608 .IP
5609 This option controls how quotes from format=flowed messages are displayed
5610 in the pager and when replying (with $text_flowed \fIunset\fP).
5611 When set, this option adds spaces after each level of quote marks, turning
5612 \(rq>>>foo\(rq into \(rq> > > foo\(rq.
5613 .IP
5614 \fBNote:\fP If $reflow_text is \fIunset\fP, this option has no effect.
5615 Also, this option does not affect replies when $text_flowed is \fIset\fP.
5616
5617
5618 .TP
5619 .B reflow_text
5620 .nf
5621 Type: boolean
5622 Default: yes
5623 .fi
5624 .IP
5625 When \fIset\fP, Mutt will reformat paragraphs in text/plain
5626 parts marked format=flowed. If \fIunset\fP, Mutt will display paragraphs
5627 unaltered from how they appear in the message body. See RFC3676 for
5628 details on the \fIformat=flowed\fP format.
5629 .IP
5630 Also see $reflow_wrap, and $wrap.
5631
5632
5633 .TP
5634 .B reflow_wrap
5635 .nf
5636 Type: number
5637 Default: 78
5638 .fi
5639 .IP
5640 This variable controls the maximum paragraph width when reformatting text/plain
5641 parts when $reflow_text is \fIset\fP. When the value is 0, paragraphs will
5642 be wrapped at the terminal's right margin. A positive value sets the
5643 paragraph width relative to the left margin. A negative value set the
5644 paragraph width relative to the right margin.
5645 .IP
5646 Also see $wrap.
5647
5648
5649 .TP
5650 .B reply_regexp
5651 .nf
5652 Type: regular expression (localized)
5653 Default: \(lq^(re)(\\[[0\-9]+\\])*:[ \\t]*\(rq
5654 .fi
5655 .IP
5656 A regular expression used to recognize reply messages when
5657 threading and replying. The default value corresponds to the
5658 standard Latin \(rqRe:\(rq prefix.
5659 .IP
5660 This value may have been localized by the translator for your
5661 locale, adding other prefixes that are common in the locale. You
5662 can add your own prefixes by appending inside \fB\(rq^(re)\(rq\fP. For
5663 example: \fB\(rq^(re|se)\(rq\fP or \fB\(rq^(re|aw|se)\(rq\fP.
5664 .IP
5665 The second parenthesized expression matches zero or more
5666 bracketed numbers following the prefix, such as \fB\(rqRe[1]: \(rq\fP.
5667 The initial \fB\(rq\\\\[\(rq\fP means a literal left\-bracket character.
5668 Note the backslash must be doubled when used inside a double
5669 quoted string in the muttrc. \fB\(rq[0\-9]+\(rq\fP means one or more
5670 numbers. \fB\(rq\\\\]\(rq\fP means a literal right\-bracket. Finally the
5671 whole parenthesized expression has a \fB\(rq*\(rq\fP suffix, meaning it
5672 can occur zero or more times.
5673 .IP
5674 The last part matches a colon followed by an optional space or
5675 tab. Note \fB\(rq\\t\(rq\fP is converted to a literal tab inside a
5676 double quoted string. If you use a single quoted string, you
5677 would have to type an actual tab character, and would need to
5678 convert the double\-backslashes to single backslashes.
5679 .IP
5680 Note: the result of this regexp match against the subject is
5681 stored in the header cache. Mutt isn't smart enough to
5682 invalidate a header cache entry based on changing $reply_regexp,
5683 so if you aren't seeing correct values in the index, try
5684 temporarily turning off the header cache. If that fixes the
5685 problem, then once the variable is set to your liking, remove
5686 your stale header cache files and turn the header cache back on.
5687
5688
5689 .TP
5690 .B reply_self
5691 .nf
5692 Type: boolean
5693 Default: no
5694 .fi
5695 .IP
5696 If \fIunset\fP and you are replying to a message sent by you, Mutt will
5697 assume that you want to reply to the recipients of that message rather
5698 than to yourself.
5699 .IP
5700 Also see the \(lqalternates\(rq command.
5701
5702
5703 .TP
5704 .B reply_to
5705 .nf
5706 Type: quadoption
5707 Default: ask\-yes
5708 .fi
5709 .IP
5710 If \fIset\fP, when replying to a message, Mutt will use the address listed
5711 in the Reply\-to: header as the recipient of the reply. If \fIunset\fP,
5712 it will use the address in the From: header field instead. This
5713 option is useful for reading a mailing list that sets the Reply\-To:
5714 header field to the list address and you want to send a private
5715 message to the author of a message.
5716
5717
5718 .TP
5719 .B resolve
5720 .nf
5721 Type: boolean
5722 Default: yes
5723 .fi
5724 .IP
5725 When \fIset\fP, the cursor will be automatically advanced to the next
5726 (possibly undeleted) message whenever a command that modifies the
5727 current message is executed.
5728
5729
5730 .TP
5731 .B resume_draft_files
5732 .nf
5733 Type: boolean
5734 Default: no
5735 .fi
5736 .IP
5737 If \fIset\fP, draft files (specified by \fB\-H\fP on the command
5738 line) are processed similarly to when resuming a postponed
5739 message. Recipients are not prompted for; send\-hooks are not
5740 evaluated; no alias expansion takes place; user\-defined headers
5741 and signatures are not added to the message.
5742
5743
5744 .TP
5745 .B resume_edited_draft_files
5746 .nf
5747 Type: boolean
5748 Default: yes
5749 .fi
5750 .IP
5751 If \fIset\fP, draft files previously edited (via \fB\-E \-H\fP on
5752 the command line) will have $resume_draft_files automatically
5753 set when they are used as a draft file again.
5754 .IP
5755 The first time a draft file is saved, mutt will add a header,
5756 X\-Mutt\-Resume\-Draft to the saved file. The next time the draft
5757 file is read in, if mutt sees the header, it will set
5758 $resume_draft_files.
5759 .IP
5760 This option is designed to prevent multiple signatures,
5761 user\-defined headers, and other processing effects from being
5762 made multiple times to the draft file.
5763
5764
5765 .TP
5766 .B reverse_alias
5767 .nf
5768 Type: boolean
5769 Default: no
5770 .fi
5771 .IP
5772 This variable controls whether or not Mutt will display the \(lqpersonal\(rq
5773 name from your aliases in the index menu if it finds an alias that
5774 matches the message's sender. For example, if you have the following
5775 alias:
5776
5777 .IP
5778 .EX
5779 alias juser [email protected] (Joe User)
5780
5781 .EE
5782 .IP
5783 and then you receive mail which contains the following header:
5784
5785 .IP
5786 .EX
5787 From: [email protected]
5788
5789 .EE
5790 .IP
5791 It would be displayed in the index menu as \(lqJoe User\(rq instead of
5792 \([email protected].\(rq This is useful when the person's e\-mail
5793 address is not human friendly.
5794
5795
5796 .TP
5797 .B reverse_name
5798 .nf
5799 Type: boolean
5800 Default: no
5801 .fi
5802 .IP
5803 It may sometimes arrive that you receive mail to a certain machine,
5804 move the messages to another machine, and reply to some the messages
5805 from there. If this variable is \fIset\fP, the default \fIFrom:\fP line of
5806 the reply messages is built using the address where you received the
5807 messages you are replying to \fBif\fP that address matches your
5808 \(lqalternates\(rq. If the variable is \fIunset\fP, or the address that would be
5809 used doesn't match your \(lqalternates\(rq, the \fIFrom:\fP line will use
5810 your address on the current machine.
5811 .IP
5812 Also see the \(lqalternates\(rq command and $reverse_realname.
5813
5814
5815 .TP
5816 .B reverse_realname
5817 .nf
5818 Type: boolean
5819 Default: yes
5820 .fi
5821 .IP
5822 This variable fine\-tunes the behavior of the $reverse_name feature.
5823 .IP
5824 When it is \fIunset\fP, Mutt will remove the real name part of a
5825 matching address. This allows the use of the email address
5826 without having to also use what the sender put in the real name
5827 field.
5828 .IP
5829 When it is \fIset\fP, Mutt will use the matching address as\-is.
5830 .IP
5831 In either case, a missing real name will be filled in afterwards
5832 using the value of $realname.
5833
5834
5835 .TP
5836 .B rfc2047_parameters
5837 .nf
5838 Type: boolean
5839 Default: yes
5840 .fi
5841 .IP
5842 When this variable is \fIset\fP, Mutt will decode RFC2047\-encoded MIME
5843 parameters. You want to set this variable when mutt suggests you
5844 to save attachments to files named like:
5845
5846 .IP
5847 .EX
5848 =?iso\-8859\-1?Q?file=5F=E4=5F991116=2Ezip?=
5849
5850 .EE
5851 .IP
5852 When this variable is \fIset\fP interactively, the change won't be
5853 active until you change folders.
5854 .IP
5855 Note that this use of RFC2047's encoding is explicitly
5856 prohibited by the standard, but nevertheless encountered in the
5857 wild.
5858 .IP
5859 Also note that setting this parameter will \fInot\fP have the effect
5860 that mutt \fIgenerates\fP this kind of encoding. Instead, mutt will
5861 unconditionally use the encoding specified in RFC2231.
5862
5863
5864 .TP
5865 .B save_address
5866 .nf
5867 Type: boolean
5868 Default: no
5869 .fi
5870 .IP
5871 If \fIset\fP, mutt will take the sender's full address when choosing a
5872 default folder for saving a mail. If $save_name or $force_name
5873 is \fIset\fP too, the selection of the Fcc folder will be changed as well.
5874
5875
5876 .TP
5877 .B save_empty
5878 .nf
5879 Type: boolean
5880 Default: yes
5881 .fi
5882 .IP
5883 When \fIunset\fP, mailboxes which contain no saved messages will be removed
5884 when closed (the exception is $spoolfile which is never removed).
5885 If \fIset\fP, mailboxes are never removed.
5886 .IP
5887 \fBNote:\fP This only applies to mbox and MMDF folders, Mutt does not
5888 delete MH and Maildir directories.
5889
5890
5891 .TP
5892 .B save_history
5893 .nf
5894 Type: number
5895 Default: 0
5896 .fi
5897 .IP
5898 This variable controls the size of the history (per category) saved in the
5899 $history_file file.
5900
5901
5902 .TP
5903 .B save_name
5904 .nf
5905 Type: boolean
5906 Default: no
5907 .fi
5908 .IP
5909 This variable controls how copies of outgoing messages are saved.
5910 When \fIset\fP, a check is made to see if a mailbox specified by the
5911 recipient address exists (this is done by searching for a mailbox in
5912 the $folder directory with the \fIusername\fP part of the
5913 recipient address). If the mailbox exists, the outgoing message will
5914 be saved to that mailbox, otherwise the message is saved to the
5915 $record mailbox.
5916 .IP
5917 Also see the $force_name variable.
5918
5919
5920 .TP
5921 .B score
5922 .nf
5923 Type: boolean
5924 Default: yes
5925 .fi
5926 .IP
5927 When this variable is \fIunset\fP, scoring is turned off. This can
5928 be useful to selectively disable scoring for certain folders when the
5929 $score_threshold_delete variable and related are used.
5930
5931
5932 .TP
5933 .B score_threshold_delete
5934 .nf
5935 Type: number
5936 Default: \-1
5937 .fi
5938 .IP
5939 Messages which have been assigned a score equal to or lower than the value
5940 of this variable are automatically marked for deletion by mutt. Since
5941 mutt scores are always greater than or equal to zero, the default setting
5942 of this variable will never mark a message for deletion.
5943
5944
5945 .TP
5946 .B score_threshold_flag
5947 .nf
5948 Type: number
5949 Default: 9999
5950 .fi
5951 .IP
5952 Messages which have been assigned a score greater than or equal to this
5953 variable's value are automatically marked \(rqflagged\(rq.
5954
5955
5956 .TP
5957 .B score_threshold_read
5958 .nf
5959 Type: number
5960 Default: \-1
5961 .fi
5962 .IP
5963 Messages which have been assigned a score equal to or lower than the value
5964 of this variable are automatically marked as read by mutt. Since
5965 mutt scores are always greater than or equal to zero, the default setting
5966 of this variable will never mark a message read.
5967
5968
5969 .TP
5970 .B search_context
5971 .nf
5972 Type: number
5973 Default: 0
5974 .fi
5975 .IP
5976 For the pager, this variable specifies the number of lines shown
5977 before search results. By default, search results will be top\-aligned.
5978
5979
5980 .TP
5981 .B send_charset
5982 .nf
5983 Type: string
5984 Default: \(lqus\-ascii:iso\-8859\-1:utf\-8\(rq
5985 .fi
5986 .IP
5987 A colon\-delimited list of character sets for outgoing messages. Mutt will use the
5988 first character set into which the text can be converted exactly.
5989 If your $charset is not \(lqiso\-8859\-1\(rq and recipients may not
5990 understand \(lqUTF\-8\(rq, it is advisable to include in the list an
5991 appropriate widely used standard character set (such as
5992 \(lqiso\-8859\-2\(rq, \(lqkoi8\-r\(rq or \(lqiso\-2022\-jp\(rq) either instead of or after
5993 \(lqiso\-8859\-1\(rq.
5994 .IP
5995 In case the text cannot be converted into one of these exactly,
5996 mutt uses $charset as a fallback.
5997
5998
5999 .TP
6000 .B send_multipart_alternative
6001 .nf
6002 Type: quadoption
6003 Default: no
6004 .fi
6005 .IP
6006 If \fIset\fP, Mutt will generate a multipart/alternative
6007 container and an alternative part using the filter script specified in
6008 $send_multipart_alternative_filter.
6009 See the section \(lqMIME Multipart/Alternative\(rq (alternative-order).
6010 .IP
6011 Note that enabling multipart/alternative is not compatible with inline
6012 PGP encryption. Mutt will prompt to use PGP/MIME in that case.
6013
6014
6015 .TP
6016 .B send_multipart_alternative_filter
6017 .nf
6018 Type: path
6019 Default: \(lq\(rq
6020 .fi
6021 .IP
6022 This specifies a filter script, which will convert the main
6023 (composed) message of the email to an alternative format. The
6024 message will be piped to the filter's stdin. The expected output
6025 of the filter is the generated mime type, e.g. text/html,
6026 followed by a blank line, and then the converted content.
6027 See the section \(lqMIME Multipart/Alternative\(rq (alternative-order).
6028
6029
6030 .TP
6031 .B sendmail
6032 .nf
6033 Type: path
6034 Default: \(lq/usr/sbin/sendmail \-oem \-oi\(rq
6035 .fi
6036 .IP
6037 Specifies the program and arguments used to deliver mail sent by Mutt.
6038 Mutt expects that the specified program interprets additional
6039 arguments as recipient addresses. Mutt appends all recipients after
6040 adding a \fB\-\-\fP delimiter (if not already present). Additional
6041 flags, such as for $use_8bitmime, $use_envelope_from,
6042 $dsn_notify, or $dsn_return will be added before the delimiter.
6043 .IP
6044 \fBNote:\fP This command is invoked differently from most other
6045 commands in Mutt. It is tokenized by space, and invoked directly
6046 via \fBexecvp(3)\fP with an array of arguments \- so commands or
6047 arguments with spaces in them are not supported. The shell is
6048 not used to run the command, so shell quoting is also not
6049 supported.
6050 .IP
6051 \fBSee also:\fP $write_bcc.
6052
6053
6054 .TP
6055 .B sendmail_wait
6056 .nf
6057 Type: number
6058 Default: 0
6059 .fi
6060 .IP
6061 Specifies the number of seconds to wait for the $sendmail process
6062 to finish before giving up and putting delivery in the background.
6063 .IP
6064 Mutt interprets the value of this variable as follows:
6065 .RS
6066 .PD 0
6067 .TP
6068 >0
6069 number of seconds to wait for sendmail to finish before continuing
6070 .TP
6071 0
6072 wait forever for sendmail to finish
6073 .TP
6074 <0
6075 always put sendmail in the background without waiting
6076 .RE
6077 .PD 1
6078 .IP
6079 Note that if you specify a value other than 0, the output of the child
6080 process will be put in a temporary file. If there is some error, you
6081 will be informed as to where to find the output.
6082
6083
6084 .TP
6085 .B shell
6086 .nf
6087 Type: path
6088 Default: \(lq\(rq
6089 .fi
6090 .IP
6091 Command to use when spawning a subshell. By default, the user's login
6092 shell from \fB/etc/passwd\fP is used.
6093
6094
6095 .TP
6096 .B sidebar_delim_chars
6097 .nf
6098 Type: string
6099 Default: \(lq/.\(rq
6100 .fi
6101 .IP
6102 This contains the list of characters which you would like to treat
6103 as folder separators for displaying paths in the sidebar.
6104 .IP
6105 Local mail is often arranged in directories: `dir1/dir2/mailbox'.
6106
6107 .IP
6108 .EX
6109 set sidebar_delim_chars='/'
6110
6111 .EE
6112 .IP
6113 IMAP mailboxes are often named: `folder1.folder2.mailbox'.
6114
6115 .IP
6116 .EX
6117 set sidebar_delim_chars='.'
6118
6119 .EE
6120 .IP
6121 \fBSee also:\fP $sidebar_short_path, $sidebar_folder_indent, $sidebar_indent_string.
6122
6123
6124 .TP
6125 .B sidebar_divider_char
6126 .nf
6127 Type: string
6128 Default: \(lq|\(rq
6129 .fi
6130 .IP
6131 This specifies the characters to be drawn between the sidebar (when
6132 visible) and the other Mutt panels. ASCII and Unicode line\-drawing
6133 characters are supported.
6134
6135
6136 .TP
6137 .B sidebar_folder_indent
6138 .nf
6139 Type: boolean
6140 Default: no
6141 .fi
6142 .IP
6143 Set this to indent mailboxes in the sidebar.
6144 .IP
6145 \fBSee also:\fP $sidebar_short_path, $sidebar_indent_string, $sidebar_delim_chars.
6146
6147
6148 .TP
6149 .B sidebar_format
6150 .nf
6151 Type: string
6152 Default: \(lq%B%* %n\(rq
6153 .fi
6154 .IP
6155 This variable allows you to customize the sidebar display. This string is
6156 similar to $index_format, but has its own set of \fBprintf(3)\fP\-like
6157 sequences:
6158 .RS
6159 .PD 0
6160 .TP
6161 %B
6162 Name of the mailbox
6163 .TP
6164 %S
6165 * Size of mailbox (total number of messages)
6166 .TP
6167 %N
6168 * Number of unread messages in the mailbox
6169 .TP
6170 %n
6171 N if mailbox has new mail, blank otherwise
6172 .TP
6173 %F
6174 * Number of Flagged messages in the mailbox
6175 .TP
6176 %!
6177 \(lq!\(rq : one flagged message;
6178 \(lq!!\(rq : two flagged messages;
6179 \(lqn!\(rq : n flagged messages (for n > 2).
6180 Otherwise prints nothing.
6181 .TP
6182 %d
6183 * @ Number of deleted messages
6184 .TP
6185 %L
6186 * @ Number of messages after limiting
6187 .TP
6188 %t
6189 * @ Number of tagged messages
6190 .TP
6191 %>X
6192 right justify the rest of the string and pad with \(lqX\(rq
6193 .TP
6194 %|X
6195 pad to the end of the line with \(lqX\(rq
6196 .TP
6197 %*X
6198 soft\-fill with character \(lqX\(rq as pad
6199 .RE
6200 .PD 1
6201 .IP
6202 * = Can be optionally printed if nonzero
6203 @ = Only applicable to the current folder
6204 .IP
6205 In order to use %S, %N, %F, and %!, $mail_check_stats must
6206 be \fIset\fP. When thus set, a suggested value for this option is
6207 \(rq%B%?F? [%F]?%* %?N?%N/?%S\(rq.
6208
6209
6210 .TP
6211 .B sidebar_indent_string
6212 .nf
6213 Type: string
6214 Default: \(lq \(rq
6215 .fi
6216 .IP
6217 This specifies the string that is used to indent mailboxes in the sidebar.
6218 It defaults to two spaces.
6219 .IP
6220 \fBSee also:\fP $sidebar_short_path, $sidebar_folder_indent, $sidebar_delim_chars.
6221
6222
6223 .TP
6224 .B sidebar_new_mail_only
6225 .nf
6226 Type: boolean
6227 Default: no
6228 .fi
6229 .IP
6230 When set, the sidebar will only display mailboxes containing new, or
6231 flagged, mail.
6232 .IP
6233 \fBSee also:\fP sidebar_whitelist.
6234
6235
6236 .TP
6237 .B sidebar_next_new_wrap
6238 .nf
6239 Type: boolean
6240 Default: no
6241 .fi
6242 .IP
6243 When set, the \fB<sidebar\-next\-new>\fP command will not stop and the end of
6244 the list of mailboxes, but wrap around to the beginning. The
6245 \fB<sidebar\-prev\-new>\fP command is similarly affected, wrapping around to
6246 the end of the list.
6247
6248
6249 .TP
6250 .B sidebar_relative_shortpath_indent
6251 .nf
6252 Type: boolean
6253 Default: no
6254 .fi
6255 .IP
6256 When set, this option changes how $sidebar_short_path and
6257 $sidebar_folder_indent perform shortening and indentation: both
6258 will look at the previous sidebar entries and shorten/indent
6259 relative to the most recent parent.
6260 .IP
6261 An example of this option set/unset for mailboxes listed in this
6262 order, with $sidebar_short_path=yes,
6263 $sidebar_folder_indent=yes, and $sidebar_indent_string=\(rq→\(rq:
6264 .RS
6265 .PD 0
6266 .TP
6267 \fBmailbox\fP
6268 \fBset\fP
6269 \fBunset\fP
6270 .TP
6271 \fB=a.b\fP
6272 \fB=a.b\fP
6273 \fB→b\fP
6274 .TP
6275 \fB=a.b.c.d\fP
6276 \fB→c.d\fP
6277 \fB→→→d\fP
6278 .TP
6279 \fB=a.b.e\fP
6280 \fB→e\fP
6281 \fB→→e\fP
6282 .RE
6283 .PD 1
6284 .IP
6285 The second line illustrates most clearly. With this option set,
6286 \fB=a.b.c.d\fP is shortened relative to \fB=a.b\fP, becoming
6287 \fBc.d\fP; it is also indented one place relative to \fB=a.b\fP.
6288 With this option unset \fB=a.b.c.d\fP is always shortened to the
6289 last part of the mailbox, \fBd\fP and is indented three places,
6290 with respect to $folder (represented by '=').
6291 .IP
6292 When set, the third line will also be indented and shortened
6293 relative to the first line.
6294
6295
6296 .TP
6297 .B sidebar_short_path
6298 .nf
6299 Type: boolean
6300 Default: no
6301 .fi
6302 .IP
6303 By default the sidebar will show the mailbox's path, relative to the
6304 $folder variable. Setting \fBsidebar_shortpath=yes\fP will shorten the
6305 names relative to the previous name. Here's an example:
6306 .RS
6307 .PD 0
6308 .TP
6309 \fBshortpath=no\fP
6310 \fBshortpath=yes\fP
6311 \fBshortpath=yes, folderindent=yes, indentstr=\(rq..\(rq\fP
6312 .TP
6313 \fBfruit\fP
6314 \fBfruit\fP
6315 \fBfruit\fP
6316 .TP
6317 \fBfruit.apple\fP
6318 \fBapple\fP
6319 \fB..apple\fP
6320 .TP
6321 \fBfruit.banana\fP
6322 \fBbanana\fP
6323 \fB..banana\fP
6324 .TP
6325 \fBfruit.cherry\fP
6326 \fBcherry\fP
6327 \fB..cherry\fP
6328 .RE
6329 .PD 1
6330 .IP
6331 \fBSee also:\fP $sidebar_delim_chars, $sidebar_folder_indent, $sidebar_indent_string.
6332
6333
6334 .TP
6335 .B sidebar_sort_method
6336 .nf
6337 Type: sort order
6338 Default: unsorted
6339 .fi
6340 .IP
6341 Specifies how to sort mailbox entries in the sidebar. By default, the
6342 entries are sorted alphabetically. Valid values:
6343 .RS
6344 .PD 0
6345 .TP
6346 \(hy alpha (alphabetically)
6347 .TP
6348 \(hy count (all message count)
6349 .TP
6350 \(hy flagged (flagged message count)
6351 .TP
6352 \(hy name (alphabetically)
6353 .TP
6354 \(hy new (unread message count)
6355 .TP
6356 \(hy path (alphabetically)
6357 .TP
6358 \(hy unread (unread message count)
6359 .TP
6360 \(hy unsorted
6361 .RE
6362 .PD 1
6363 .IP
6364 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
6365 order (example: \(lq\fBset sidebar_sort_method=reverse\-alpha\fP\(rq).
6366
6367
6368 .TP
6369 .B sidebar_use_mailbox_shortcuts
6370 .nf
6371 Type: boolean
6372 Default: no
6373 .fi
6374 .IP
6375 When set, sidebar mailboxes will be displayed with mailbox shortcut prefixes
6376 \(rq=\(rq or \(rq~\(rq.
6377 .IP
6378 When unset, the sidebar will trim off a matching $folder prefix
6379 but otherwise not use mailbox shortcuts.
6380
6381
6382 .TP
6383 .B sidebar_visible
6384 .nf
6385 Type: boolean
6386 Default: no
6387 .fi
6388 .IP
6389 This specifies whether or not to show sidebar. The sidebar shows a list of
6390 all your mailboxes.
6391 .IP
6392 \fBSee also:\fP $sidebar_format, $sidebar_width
6393
6394
6395 .TP
6396 .B sidebar_width
6397 .nf
6398 Type: number
6399 Default: 30
6400 .fi
6401 .IP
6402 This controls the width of the sidebar. It is measured in screen columns.
6403 For example: sidebar_width=20 could display 20 ASCII characters, or 10
6404 Chinese characters.
6405
6406
6407 .TP
6408 .B sig_dashes
6409 .nf
6410 Type: boolean
6411 Default: yes
6412 .fi
6413 .IP
6414 If \fIset\fP, a line containing \(lq\-\- \(rq (note the trailing space) will be inserted before your
6415 $signature. It is \fBstrongly\fP recommended that you not \fIunset\fP
6416 this variable unless your signature contains just your name. The
6417 reason for this is because many software packages use \(lq\-\- \\n\(rq to
6418 detect your signature. For example, Mutt has the ability to highlight
6419 the signature in a different color in the built\-in pager.
6420
6421
6422 .TP
6423 .B sig_on_top
6424 .nf
6425 Type: boolean
6426 Default: no
6427 .fi
6428 .IP
6429 If \fIset\fP, the signature will be included before any quoted or forwarded
6430 text. It is \fBstrongly\fP recommended that you do not set this variable
6431 unless you really know what you are doing, and are prepared to take
6432 some heat from netiquette guardians.
6433
6434
6435 .TP
6436 .B signature
6437 .nf
6438 Type: path
6439 Default: \(lq~/.signature\(rq
6440 .fi
6441 .IP
6442 Specifies the filename of your signature, which is appended to all
6443 outgoing messages. If the filename ends with a pipe (\(lq|\(rq), it is
6444 assumed that filename is a shell command and input should be read from
6445 its standard output.
6446
6447
6448 .TP
6449 .B simple_search
6450 .nf
6451 Type: string
6452 Default: \(lq~f %s | ~s %s\(rq
6453 .fi
6454 .IP
6455 Specifies how Mutt should expand a simple search into a real search
6456 pattern. A simple search is one that does not contain any of the \(lq~\(rq pattern
6457 modifiers. See \(lqpatterns\(rq for more information on search patterns.
6458 .IP
6459 For example, if you simply type \(lqjoe\(rq at a search or limit prompt, Mutt
6460 will automatically expand it to the value specified by this variable by
6461 replacing \(lq%s\(rq with the supplied string.
6462 For the default value, \(lqjoe\(rq would be expanded to: \(lq~f joe | ~s joe\(rq.
6463
6464
6465 .TP
6466 .B size_show_bytes
6467 .nf
6468 Type: boolean
6469 Default: no
6470 .fi
6471 .IP
6472 If \fIset\fP, message sizes will display bytes for values less than
6473 1 kilobyte. See formatstrings-size.
6474
6475
6476 .TP
6477 .B size_show_fractions
6478 .nf
6479 Type: boolean
6480 Default: yes
6481 .fi
6482 .IP
6483 If \fIset\fP, message sizes will be displayed with a single decimal value
6484 for sizes from 0 to 10 kilobytes and 1 to 10 megabytes.
6485 See formatstrings-size.
6486
6487
6488 .TP
6489 .B size_show_mb
6490 .nf
6491 Type: boolean
6492 Default: yes
6493 .fi
6494 .IP
6495 If \fIset\fP, message sizes will display megabytes for values greater than
6496 or equal to 1 megabyte. See formatstrings-size.
6497
6498
6499 .TP
6500 .B size_units_on_left
6501 .nf
6502 Type: boolean
6503 Default: no
6504 .fi
6505 .IP
6506 If \fIset\fP, message sizes units will be displayed to the left of the number.
6507 See formatstrings-size.
6508
6509
6510 .TP
6511 .B sleep_time
6512 .nf
6513 Type: number
6514 Default: 1
6515 .fi
6516 .IP
6517 Specifies time, in seconds, to pause while displaying certain informational
6518 messages, while moving from folder to folder and after expunging
6519 messages from the current folder. The default is to pause one second, so
6520 a value of zero for this option suppresses the pause.
6521
6522
6523 .TP
6524 .B smart_wrap
6525 .nf
6526 Type: boolean
6527 Default: yes
6528 .fi
6529 .IP
6530 Controls the display of lines longer than the screen width in the
6531 internal pager. If \fIset\fP, long lines are wrapped at a word boundary. If
6532 \fIunset\fP, lines are simply wrapped at the screen edge. Also see the
6533 $markers variable.
6534
6535
6536 .TP
6537 .B smileys
6538 .nf
6539 Type: regular expression
6540 Default: \(lq(>From )|(:[\-^]?[][)(><}{|/DP])\(rq
6541 .fi
6542 .IP
6543 The \fIpager\fP uses this variable to catch some common false
6544 positives of $quote_regexp, most notably smileys and not consider
6545 a line quoted text if it also matches $smileys. This mostly
6546 happens at the beginning of a line.
6547
6548
6549 .TP
6550 .B smime_ask_cert_label
6551 .nf
6552 Type: boolean
6553 Default: yes
6554 .fi
6555 .IP
6556 This flag controls whether you want to be asked to enter a label
6557 for a certificate about to be added to the database or not. It is
6558 \fIset\fP by default.
6559 (S/MIME only)
6560
6561
6562 .TP
6563 .B smime_ca_location
6564 .nf
6565 Type: path
6566 Default: \(lq\(rq
6567 .fi
6568 .IP
6569 This variable contains the name of either a directory, or a file which
6570 contains trusted certificates for use with OpenSSL.
6571 (S/MIME only)
6572
6573
6574 .TP
6575 .B smime_certificates
6576 .nf
6577 Type: path
6578 Default: \(lq\(rq
6579 .fi
6580 .IP
6581 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
6582 storage and retrieval of keys by itself. This is very basic right
6583 now, and keys and certificates are stored in two different
6584 directories, both named as the hash\-value retrieved from
6585 OpenSSL. There is an index file which contains mailbox\-address
6586 keyid pairs, and which can be manually edited. This option points to
6587 the location of the certificates.
6588 (S/MIME only)
6589
6590
6591 .TP
6592 .B smime_decrypt_command
6593 .nf
6594 Type: string
6595 Default: \(lq\(rq
6596 .fi
6597 .IP
6598 This format string specifies a command which is used to decrypt
6599 \fBapplication/x\-pkcs7\-mime\fP attachments.
6600 .IP
6601 The OpenSSL command formats have their own set of \fBprintf(3)\fP\-like sequences
6602 similar to PGP's:
6603 .RS
6604 .PD 0
6605 .TP
6606 %f
6607 Expands to the name of a file containing a message.
6608 .TP
6609 %s
6610 Expands to the name of a file containing the signature part
6611 of a \fBmultipart/signed\fP attachment when verifying it.
6612 .TP
6613 %k
6614 The key\-pair specified with $smime_default_key
6615 .TP
6616 %c
6617 One or more certificate IDs.
6618 .TP
6619 %a
6620 The algorithm used for encryption.
6621 .TP
6622 %d
6623 The message digest algorithm specified with $smime_sign_digest_alg.
6624 .TP
6625 %C
6626 CA location: Depending on whether $smime_ca_location
6627 points to a directory or file, this expands to
6628 \(lq\-CApath $smime_ca_location\(rq or \(lq\-CAfile $smime_ca_location\(rq.
6629 .RE
6630 .PD 1
6631 .IP
6632 For examples on how to configure these formats, see the \fBsmime.rc\fP in
6633 the \fBsamples/\fP subdirectory which has been installed on your system
6634 alongside the documentation.
6635 (S/MIME only)
6636
6637
6638 .TP
6639 .B smime_decrypt_use_default_key
6640 .nf
6641 Type: boolean
6642 Default: yes
6643 .fi
6644 .IP
6645 If \fIset\fP (default) this tells mutt to use the default key for decryption. Otherwise,
6646 if managing multiple certificate\-key\-pairs, mutt will try to use the mailbox\-address
6647 to determine the key to use. It will ask you to supply a key, if it can't find one.
6648 (S/MIME only)
6649
6650
6651 .TP
6652 .B smime_default_key
6653 .nf
6654 Type: string
6655 Default: \(lq\(rq
6656 .fi
6657 .IP
6658 This is the default key\-pair to use for S/MIME operations, and must be
6659 set to the keyid (the hash\-value that OpenSSL generates) to work properly.
6660 .IP
6661 It will be used for encryption (see $postpone_encrypt and
6662 $smime_self_encrypt). If GPGME is enabled, this is the key id displayed
6663 by gpgsm.
6664 .IP
6665 It will be used for decryption unless $smime_decrypt_use_default_key
6666 is \fIunset\fP.
6667 .IP
6668 It will also be used for signing unless $smime_sign_as is set.
6669 .IP
6670 The (now deprecated) \fIsmime_self_encrypt_as\fP is an alias for this
6671 variable, and should no longer be used.
6672 (S/MIME only)
6673
6674
6675 .TP
6676 .B smime_encrypt_command
6677 .nf
6678 Type: string
6679 Default: \(lq\(rq
6680 .fi
6681 .IP
6682 This command is used to create encrypted S/MIME messages.
6683 .IP
6684 This is a format string, see the $smime_decrypt_command command for
6685 possible \fBprintf(3)\fP\-like sequences.
6686 (S/MIME only)
6687
6688
6689 .TP
6690 .B smime_encrypt_with
6691 .nf
6692 Type: string
6693 Default: \(lqaes256\(rq
6694 .fi
6695 .IP
6696 This sets the algorithm that should be used for encryption.
6697 Valid choices are \(lqaes128\(rq, \(lqaes192\(rq, \(lqaes256\(rq, \(lqdes\(rq, \(lqdes3\(rq, \(lqrc2\-40\(rq, \(lqrc2\-64\(rq, \(lqrc2\-128\(rq.
6698 (S/MIME only)
6699
6700
6701 .TP
6702 .B smime_get_cert_command
6703 .nf
6704 Type: string
6705 Default: \(lq\(rq
6706 .fi
6707 .IP
6708 This command is used to extract X509 certificates from a PKCS7 structure.
6709 .IP
6710 This is a format string, see the $smime_decrypt_command command for
6711 possible \fBprintf(3)\fP\-like sequences.
6712 (S/MIME only)
6713
6714
6715 .TP
6716 .B smime_get_cert_email_command
6717 .nf
6718 Type: string
6719 Default: \(lq\(rq
6720 .fi
6721 .IP
6722 This command is used to extract the mail address(es) used for storing
6723 X509 certificates, and for verification purposes (to check whether the
6724 certificate was issued for the sender's mailbox).
6725 .IP
6726 This is a format string, see the $smime_decrypt_command command for
6727 possible \fBprintf(3)\fP\-like sequences.
6728 (S/MIME only)
6729
6730
6731 .TP
6732 .B smime_get_signer_cert_command
6733 .nf
6734 Type: string
6735 Default: \(lq\(rq
6736 .fi
6737 .IP
6738 This command is used to extract only the signers X509 certificate from a S/MIME
6739 signature, so that the certificate's owner may get compared to the
6740 email's \(lqFrom:\(rq field.
6741 .IP
6742 This is a format string, see the $smime_decrypt_command command for
6743 possible \fBprintf(3)\fP\-like sequences.
6744 (S/MIME only)
6745
6746
6747 .TP
6748 .B smime_import_cert_command
6749 .nf
6750 Type: string
6751 Default: \(lq\(rq
6752 .fi
6753 .IP
6754 This command is used to import a certificate via smime_keys.
6755 .IP
6756 This is a format string, see the $smime_decrypt_command command for
6757 possible \fBprintf(3)\fP\-like sequences.
6758 (S/MIME only)
6759
6760
6761 .TP
6762 .B smime_is_default
6763 .nf
6764 Type: boolean
6765 Default: no
6766 .fi
6767 .IP
6768 The default behavior of mutt is to use PGP on all auto\-sign/encryption
6769 operations. To override and to use OpenSSL instead this must be \fIset\fP.
6770 However, this has no effect while replying, since mutt will automatically
6771 select the same application that was used to sign/encrypt the original
6772 message. (Note that this variable can be overridden by unsetting $crypt_autosmime.)
6773 (S/MIME only)
6774
6775
6776 .TP
6777 .B smime_keys
6778 .nf
6779 Type: path
6780 Default: \(lq\(rq
6781 .fi
6782 .IP
6783 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
6784 storage and retrieval of keys/certs by itself. This is very basic right now,
6785 and stores keys and certificates in two different directories, both
6786 named as the hash\-value retrieved from OpenSSL. There is an index file
6787 which contains mailbox\-address keyid pair, and which can be manually
6788 edited. This option points to the location of the private keys.
6789 (S/MIME only)
6790
6791
6792 .TP
6793 .B smime_pk7out_command
6794 .nf
6795 Type: string
6796 Default: \(lq\(rq
6797 .fi
6798 .IP
6799 This command is used to extract PKCS7 structures of S/MIME signatures,
6800 in order to extract the public X509 certificate(s).
6801 .IP
6802 This is a format string, see the $smime_decrypt_command command for
6803 possible \fBprintf(3)\fP\-like sequences.
6804 (S/MIME only)
6805
6806
6807 .TP
6808 .B smime_self_encrypt
6809 .nf
6810 Type: boolean
6811 Default: yes
6812 .fi
6813 .IP
6814 When \fIset\fP, S/MIME encrypted messages will also be encrypted
6815 using the certificate in $smime_default_key.
6816 (S/MIME only)
6817
6818
6819 .TP
6820 .B smime_sign_as
6821 .nf
6822 Type: string
6823 Default: \(lq\(rq
6824 .fi
6825 .IP
6826 If you have a separate key to use for signing, you should set this
6827 to the signing key. Most people will only need to set $smime_default_key.
6828 (S/MIME only)
6829
6830
6831 .TP
6832 .B smime_sign_command
6833 .nf
6834 Type: string
6835 Default: \(lq\(rq
6836 .fi
6837 .IP
6838 This command is used to created S/MIME signatures of type
6839 \fBmultipart/signed\fP, which can be read by all mail clients.
6840 .IP
6841 This is a format string, see the $smime_decrypt_command command for
6842 possible \fBprintf(3)\fP\-like sequences. NOTE: %c and %k will default
6843 to $smime_sign_as if set, otherwise $smime_default_key.
6844 (S/MIME only)
6845
6846
6847 .TP
6848 .B smime_sign_digest_alg
6849 .nf
6850 Type: string
6851 Default: \(lqsha256\(rq
6852 .fi
6853 .IP
6854 This sets the algorithm that should be used for the signature message digest.
6855 Valid choices are \(lqmd5\(rq, \(lqsha1\(rq, \(lqsha224\(rq, \(lqsha256\(rq, \(lqsha384\(rq, \(lqsha512\(rq.
6856 (S/MIME only)
6857
6858
6859 .TP
6860 .B smime_sign_opaque_command
6861 .nf
6862 Type: string
6863 Default: \(lq\(rq
6864 .fi
6865 .IP
6866 This command is used to created S/MIME signatures of type
6867 \fBapplication/x\-pkcs7\-signature\fP, which can only be handled by mail
6868 clients supporting the S/MIME extension.
6869 .IP
6870 This is a format string, see the $smime_decrypt_command command for
6871 possible \fBprintf(3)\fP\-like sequences.
6872 (S/MIME only)
6873
6874
6875 .TP
6876 .B smime_timeout
6877 .nf
6878 Type: number (long)
6879 Default: 300
6880 .fi
6881 .IP
6882 The number of seconds after which a cached passphrase will expire if
6883 not used.
6884 (S/MIME only)
6885
6886
6887 .TP
6888 .B smime_verify_command
6889 .nf
6890 Type: string
6891 Default: \(lq\(rq
6892 .fi
6893 .IP
6894 This command is used to verify S/MIME signatures of type \fBmultipart/signed\fP.
6895 .IP
6896 This is a format string, see the $smime_decrypt_command command for
6897 possible \fBprintf(3)\fP\-like sequences.
6898 (S/MIME only)
6899
6900
6901 .TP
6902 .B smime_verify_opaque_command
6903 .nf
6904 Type: string
6905 Default: \(lq\(rq
6906 .fi
6907 .IP
6908 This command is used to verify S/MIME signatures of type
6909 \fBapplication/x\-pkcs7\-mime\fP.
6910 .IP
6911 This is a format string, see the $smime_decrypt_command command for
6912 possible \fBprintf(3)\fP\-like sequences.
6913 (S/MIME only)
6914
6915
6916 .TP
6917 .B smtp_authenticators
6918 .nf
6919 Type: string
6920 Default: \(lq\(rq
6921 .fi
6922 .IP
6923 This is a colon\-delimited list of authentication methods mutt may
6924 attempt to use to log in to an SMTP server, in the order mutt should
6925 try them. Authentication methods are any SASL mechanism, e.g.
6926 \(lqdigest\-md5\(rq, \(lqgssapi\(rq or \(lqcram\-md5\(rq.
6927 This option is case\-insensitive. If it is \(lqunset\(rq
6928 (the default) mutt will try all available methods, in order from
6929 most\-secure to least\-secure.
6930 .IP
6931 Example:
6932
6933 .IP
6934 .EX
6935 set smtp_authenticators=\(rqdigest\-md5:cram\-md5\(rq
6936
6937 .EE
6938
6939
6940 .TP
6941 .B smtp_oauth_refresh_command
6942 .nf
6943 Type: string
6944 Default: \(lq\(rq
6945 .fi
6946 .IP
6947 The command to run to generate an OAUTH refresh token for
6948 authorizing your connection to your SMTP server. This command will be
6949 run on every connection attempt that uses the OAUTHBEARER authentication
6950 mechanism. See \(lqoauth\(rq for details.
6951
6952
6953 .TP
6954 .B smtp_pass
6955 .nf
6956 Type: string
6957 Default: \(lq\(rq
6958 .fi
6959 .IP
6960 Specifies the password for your SMTP account. If \fIunset\fP, Mutt will
6961 prompt you for your password when you first send mail via SMTP.
6962 See $smtp_url to configure mutt to send mail via SMTP.
6963 .IP
6964 \fBWarning\fP: you should only use this option when you are on a
6965 fairly secure machine, because the superuser can read your muttrc even
6966 if you are the only one who can read the file.
6967
6968
6969 .TP
6970 .B smtp_url
6971 .nf
6972 Type: string
6973 Default: \(lq\(rq
6974 .fi
6975 .IP
6976 Defines the SMTP smarthost where sent messages should relayed for
6977 delivery. This should take the form of an SMTP URL, e.g.:
6978
6979 .IP
6980 .EX
6981 smtp[s]://[user[:pass]@]host[:port]
6982
6983 .EE
6984 .IP
6985 where \(lq[...]\(rq denotes an optional part.
6986 Setting this variable overrides the value of the $sendmail
6987 variable.
6988 .IP
6989 Also see $write_bcc.
6990
6991
6992 .TP
6993 .B sort
6994 .nf
6995 Type: sort order
6996 Default: date
6997 .fi
6998 .IP
6999 Specifies how to sort messages in the \(lqindex\(rq menu. Valid values
7000 are:
7001 .RS
7002 .PD 0
7003 .TP
7004 \(hy date or date\-sent
7005 .TP
7006 \(hy date\-received
7007 .TP
7008 \(hy from
7009 .TP
7010 \(hy mailbox\-order (unsorted)
7011 .TP
7012 \(hy score
7013 .TP
7014 \(hy size
7015 .TP
7016 \(hy spam
7017 .TP
7018 \(hy subject
7019 .TP
7020 \(hy threads
7021 .TP
7022 \(hy to
7023 .RE
7024 .PD 1
7025 .IP
7026 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
7027 order (example: \(lq\fBset sort=reverse\-date\-sent\fP\(rq).
7028 .IP
7029 For values except \(lqthreads\(rq, this provides the primary sort
7030 method. When two message sort values are equal, $sort_aux will
7031 be used for a secondary sort.
7032 .IP
7033 When set to \(lqthreads\(rq, Mutt threads messages in the index. It
7034 uses the variable $sort_thread_groups to sort between threads
7035 (at the top/root level), and $sort_aux to sort sub\-threads and
7036 children.
7037
7038
7039 .TP
7040 .B sort_alias
7041 .nf
7042 Type: sort order
7043 Default: alias
7044 .fi
7045 .IP
7046 Specifies how the entries in the \(lqalias\(rq menu are sorted. The
7047 following are legal values:
7048 .RS
7049 .PD 0
7050 .TP
7051 \(hy address (sort alphabetically by email address)
7052 .TP
7053 \(hy alias (sort alphabetically by alias name)
7054 .TP
7055 \(hy unsorted (leave in order specified in .muttrc)
7056 .RE
7057 .PD 1
7058
7059 .TP
7060 .B sort_aux
7061 .nf
7062 Type: sort order
7063 Default: date
7064 .fi
7065 .IP
7066 For non\-threaded mode, this provides a secondary sort for
7067 messages in the \(lqindex\(rq menu, used when the $sort value is
7068 equal for two messages.
7069 .IP
7070 When sorting by threads, this variable controls how the branches
7071 of the thread trees are sorted. This can be set to any value
7072 that $sort can, except \(lqthreads\(rq (in that case, mutt will just
7073 use \(lqdate\-sent\(rq). You can also specify the \(lqlast\-\(rq prefix in
7074 addition to the \(lqreverse\-\(rq prefix, but \(lqlast\-\(rq must come
7075 after \(lqreverse\-\(rq. The \(lqlast\-\(rq prefix causes messages to be
7076 sorted against its siblings by which has the last descendant,
7077 using the rest of $sort_aux as an ordering. For instance,
7078
7079 .IP
7080 .EX
7081 set sort_aux=last\-date\-received
7082
7083 .EE
7084 .IP
7085 would mean that if a new message is received in a sub\-thread,
7086 that sub\-thread becomes the last one displayed.
7087 .IP
7088 Note: For reversed\-threads $sort
7089 order, $sort_aux is reversed again (which is not the right thing to do,
7090 but kept to not break any existing configuration setting).
7091
7092
7093 .TP
7094 .B sort_browser
7095 .nf
7096 Type: sort order
7097 Default: alpha
7098 .fi
7099 .IP
7100 Specifies how to sort entries in the file browser. By default, the
7101 entries are sorted alphabetically. Valid values:
7102 .RS
7103 .PD 0
7104 .TP
7105 \(hy alpha (alphabetically)
7106 .TP
7107 \(hy count
7108 .TP
7109 \(hy date
7110 .TP
7111 \(hy size
7112 .TP
7113 \(hy unread
7114 .TP
7115 \(hy unsorted
7116 .RE
7117 .PD 1
7118 .IP
7119 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
7120 order (example: \(lq\fBset sort_browser=reverse\-date\fP\(rq).
7121
7122
7123 .TP
7124 .B sort_browser_mailboxes
7125 .nf
7126 Type: sort order
7127 Default: unsorted
7128 .fi
7129 .IP
7130 Specifies how to sort entries in the mailbox browser. By default, the
7131 entries are unsorted, displayed in the same order as listed
7132 in the \(lqmailboxes\(rq command. Valid values:
7133 .RS
7134 .PD 0
7135 .TP
7136 \(hy alpha (alphabetically)
7137 .TP
7138 \(hy count
7139 .TP
7140 \(hy date
7141 .TP
7142 \(hy size
7143 .TP
7144 \(hy unread
7145 .TP
7146 \(hy unsorted
7147 .RE
7148 .PD 1
7149 .IP
7150 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
7151 order (example: \(lq\fBset sort_browser_mailboxes=reverse\-alpha\fP\(rq).
7152
7153
7154 .TP
7155 .B sort_re
7156 .nf
7157 Type: boolean
7158 Default: yes
7159 .fi
7160 .IP
7161 This variable is only useful when sorting by threads with
7162 $strict_threads \fIunset\fP. In that case, it changes the heuristic
7163 mutt uses to thread messages by subject. With $sort_re \fIset\fP, mutt will
7164 only attach a message as the child of another message by subject if
7165 the subject of the child message starts with a substring matching the
7166 setting of $reply_regexp. With $sort_re \fIunset\fP, mutt will attach
7167 the message whether or not this is the case, as long as the
7168 non\-$reply_regexp parts of both messages are identical.
7169
7170
7171 .TP
7172 .B sort_thread_groups
7173 .nf
7174 Type: sort order
7175 Default: aux
7176 .fi
7177 .IP
7178 When sorting by threads, this variable controls how threads are
7179 sorted in relation to other threads (at the top/root level).
7180 This can be set to any value that $sort can, except \(lqthreads\(rq.
7181 You can also specify the \(lqlast\-\(rq prefix in addition to the
7182 \(lqreverse\-\(rq prefix, but \(lqlast\-\(rq must come after \(lqreverse\-\(rq.
7183 The \(lqlast\-\(rq prefix causes messages to be sorted against its
7184 siblings by which has the last descendant, using the rest of
7185 $sort_thread_groups as an ordering.
7186 .IP
7187 For backward compatibility, the default value is \(lqaux\(rq, which
7188 means to use $sort_aux for top\-level thread sorting too. The
7189 value \(lqaux\(rq does not respect \(lqlast\-\(rq or \(lqreverse\-\(rq
7190 prefixes, it simply delegates sorting directly to $sort_aux.
7191 .IP
7192 Note: For reversed\-threads $sort order, $sort_thread_groups is
7193 reversed again (which is not the right thing to do, but kept to
7194 not break any existing configuration setting).
7195
7196
7197 .TP
7198 .B spam_separator
7199 .nf
7200 Type: string
7201 Default: \(lq,\(rq
7202 .fi
7203 .IP
7204 This variable controls what happens when multiple spam headers
7205 are matched: if \fIunset\fP, each successive header will overwrite any
7206 previous matches value for the spam label. If \fIset\fP, each successive
7207 match will append to the previous, using this variable's value as a
7208 separator.
7209
7210
7211 .TP
7212 .B spoolfile
7213 .nf
7214 Type: path
7215 Default: \(lq\(rq
7216 .fi
7217 .IP
7218 If your spool mailbox is in a non\-default place where Mutt cannot find
7219 it, you can specify its location with this variable. Mutt will
7220 initially set this variable to the value of the environment
7221 variable \fB$MAIL\fP or \fB$MAILDIR\fP if either is defined.
7222
7223
7224 .TP
7225 .B ssl_ca_certificates_file
7226 .nf
7227 Type: path
7228 Default: \(lq\(rq
7229 .fi
7230 .IP
7231 This variable specifies a file containing trusted CA certificates.
7232 Any server certificate that is signed with one of these CA
7233 certificates is also automatically accepted. (GnuTLS only)
7234 .IP
7235 Example:
7236
7237 .IP
7238 .EX
7239 set ssl_ca_certificates_file=/etc/ssl/certs/ca\-certificates.crt
7240
7241 .EE
7242
7243
7244 .TP
7245 .B ssl_client_cert
7246 .nf
7247 Type: path
7248 Default: \(lq\(rq
7249 .fi
7250 .IP
7251 The file containing a client certificate and its associated private
7252 key.
7253
7254
7255 .TP
7256 .B ssl_force_tls
7257 .nf
7258 Type: boolean
7259 Default: yes
7260 .fi
7261 .IP
7262 If this variable is \fIset\fP, Mutt will require that all connections
7263 to remote servers be encrypted. Furthermore it will attempt to
7264 negotiate TLS even if the server does not advertise the capability,
7265 since it would otherwise have to abort the connection anyway. This
7266 option supersedes $ssl_starttls.
7267
7268
7269 .TP
7270 .B ssl_min_dh_prime_bits
7271 .nf
7272 Type: number
7273 Default: 0
7274 .fi
7275 .IP
7276 This variable specifies the minimum acceptable prime size (in bits)
7277 for use in any Diffie\-Hellman key exchange. A value of 0 will use
7278 the default from the GNUTLS library. (GnuTLS only)
7279
7280
7281 .TP
7282 .B ssl_starttls
7283 .nf
7284 Type: quadoption
7285 Default: yes
7286 .fi
7287 .IP
7288 If \fIset\fP (the default), mutt will attempt to use \fBSTARTTLS\fP on servers
7289 advertising the capability. When \fIunset\fP, mutt will not attempt to
7290 use \fBSTARTTLS\fP regardless of the server's capabilities.
7291 .IP
7292 \fBNote\fP that \fBSTARTTLS\fP is subject to many kinds of
7293 attacks, including the ability of a machine\-in\-the\-middle to
7294 suppress the advertising of support. Setting $ssl_force_tls is
7295 recommended if you rely on \fBSTARTTLS\fP.
7296
7297
7298 .TP
7299 .B ssl_use_sslv2
7300 .nf
7301 Type: boolean
7302 Default: no
7303 .fi
7304 .IP
7305 If \fIset\fP , Mutt will use SSLv2 when communicating with servers that
7306 request it. \fBN.B. As of 2011, SSLv2 is considered insecure, and using
7307 is inadvisable. See https://tools.ietf.org/html/rfc6176 .\fP
7308 (OpenSSL only)
7309
7310
7311 .TP
7312 .B ssl_use_sslv3
7313 .nf
7314 Type: boolean
7315 Default: no
7316 .fi
7317 .IP
7318 If \fIset\fP , Mutt will use SSLv3 when communicating with servers that
7319 request it. \fBN.B. As of 2015, SSLv3 is considered insecure, and using
7320 it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
7321
7322
7323 .TP
7324 .B ssl_use_tlsv1
7325 .nf
7326 Type: boolean
7327 Default: no
7328 .fi
7329 .IP
7330 If \fIset\fP , Mutt will use TLSv1.0 when communicating with servers that
7331 request it. \fBN.B. As of 2015, TLSv1.0 is considered insecure, and using
7332 it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
7333
7334
7335 .TP
7336 .B ssl_use_tlsv1_1
7337 .nf
7338 Type: boolean
7339 Default: no
7340 .fi
7341 .IP
7342 If \fIset\fP , Mutt will use TLSv1.1 when communicating with servers that
7343 request it. \fBN.B. As of 2015, TLSv1.1 is considered insecure, and using
7344 it is inadvisable. See https://tools.ietf.org/html/rfc7525 .\fP
7345
7346
7347 .TP
7348 .B ssl_use_tlsv1_2
7349 .nf
7350 Type: boolean
7351 Default: yes
7352 .fi
7353 .IP
7354 If \fIset\fP , Mutt will use TLSv1.2 when communicating with servers that
7355 request it.
7356
7357
7358 .TP
7359 .B ssl_use_tlsv1_3
7360 .nf
7361 Type: boolean
7362 Default: yes
7363 .fi
7364 .IP
7365 If \fIset\fP , Mutt will use TLSv1.3 when communicating with servers that
7366 request it.
7367
7368
7369 .TP
7370 .B ssl_usesystemcerts
7371 .nf
7372 Type: boolean
7373 Default: yes
7374 .fi
7375 .IP
7376 If set to \fIyes\fP, mutt will use CA certificates in the
7377 system\-wide certificate store when checking if a server certificate
7378 is signed by a trusted CA. (OpenSSL only)
7379
7380
7381 .TP
7382 .B ssl_verify_dates
7383 .nf
7384 Type: boolean
7385 Default: yes
7386 .fi
7387 .IP
7388 If \fIset\fP (the default), mutt will not automatically accept a server
7389 certificate that is either not yet valid or already expired. You should
7390 only unset this for particular known hosts, using the
7391 \fB<account-hook>\fP function.
7392
7393
7394 .TP
7395 .B ssl_verify_host
7396 .nf
7397 Type: boolean
7398 Default: yes
7399 .fi
7400 .IP
7401 If \fIset\fP (the default), mutt will not automatically accept a server
7402 certificate whose host name does not match the host used in your folder
7403 URL. You should only unset this for particular known hosts, using
7404 the \fB<account-hook>\fP function.
7405
7406
7407 .TP
7408 .B ssl_verify_host_override
7409 .nf
7410 Type: string
7411 Default: \(lq\(rq
7412 .fi
7413 .IP
7414 Defines an alternate host name to verify the server certificate against.
7415 This should not be set unless you are sure what you are doing, but it
7416 might be useful for connection to a .onion host without a properly
7417 configured host name in the certificate. See $ssl_verify_host.
7418
7419
7420 .TP
7421 .B ssl_verify_partial_chains
7422 .nf
7423 Type: boolean
7424 Default: no
7425 .fi
7426 .IP
7427 This option should not be changed from the default unless you understand
7428 what you are doing.
7429 .IP
7430 Setting this variable to \fIyes\fP will permit verifying partial
7431 certification chains, i. e. a certificate chain where not the root,
7432 but an intermediate certificate CA, or the host certificate, are
7433 marked trusted (in $certificate_file), without marking the root
7434 signing CA as trusted.
7435 .IP
7436 (OpenSSL 1.0.2b and newer only).
7437
7438
7439 .TP
7440 .B ssl_ciphers
7441 .nf
7442 Type: string
7443 Default: \(lq\(rq
7444 .fi
7445 .IP
7446 Contains a colon\-separated list of ciphers to use when using SSL.
7447 For OpenSSL, see ciphers(1) for the syntax of the string.
7448 .IP
7449 For GnuTLS, this option will be used in place of \(rqNORMAL\(rq at the
7450 start of the priority string. See gnutls_priority_init(3) for the
7451 syntax and more details. (Note: GnuTLS version 2.1.7 or higher is
7452 required.)
7453
7454
7455 .TP
7456 .B status_chars
7457 .nf
7458 Type: string
7459 Default: \(lq\-*%A\(rq
7460 .fi
7461 .IP
7462 Controls the characters used by the \(lq%r\(rq indicator in
7463 $status_format. The first character is used when the mailbox is
7464 unchanged. The second is used when the mailbox has been changed, and
7465 it needs to be resynchronized. The third is used if the mailbox is in
7466 read\-only mode, or if the mailbox will not be written when exiting
7467 that mailbox (You can toggle whether to write changes to a mailbox
7468 with the \fB<toggle\-write>\fP operation, bound by default to \(lq%\(rq). The fourth
7469 is used to indicate that the current folder has been opened in attach\-
7470 message mode (Certain operations like composing a new mail, replying,
7471 forwarding, etc. are not permitted in this mode).
7472
7473
7474 .TP
7475 .B status_format
7476 .nf
7477 Type: string (localized)
7478 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
7479 .fi
7480 .IP
7481 Controls the format of the status line displayed in the \(lqindex\(rq
7482 menu. This string is similar to $index_format, but has its own
7483 set of \fBprintf(3)\fP\-like sequences:
7484 .RS
7485 .PD 0
7486 .TP
7487 %b
7488 number of mailboxes with new mail *
7489 .TP
7490 %B
7491 number of backgrounded editing sessions *
7492 .TP
7493 %d
7494 number of deleted messages *
7495 .TP
7496 %f
7497 the full pathname of the current mailbox
7498 .TP
7499 %F
7500 number of flagged messages *
7501 .TP
7502 %h
7503 local hostname
7504 .TP
7505 %l
7506 size (in bytes) of the current mailbox (see formatstrings-size) *
7507 .TP
7508 %L
7509 size (in bytes) of the messages shown
7510 (i.e., which match the current limit) (see formatstrings-size) *
7511 .TP
7512 %m
7513 the number of messages in the mailbox *
7514 .TP
7515 %M
7516 the number of messages shown (i.e., which match the current limit) *
7517 .TP
7518 %n
7519 number of new messages in the mailbox *
7520 .TP
7521 %o
7522 number of old unread messages *
7523 .TP
7524 %p
7525 number of postponed messages *
7526 .TP
7527 %P
7528 percentage of the way through the index
7529 .TP
7530 %r
7531 modified/read\-only/won't\-write/attach\-message indicator,
7532 according to $status_chars
7533 .TP
7534 %R
7535 number of read messages *
7536 .TP
7537 %s
7538 current sorting mode ($sort)
7539 .TP
7540 %S
7541 current aux sorting method ($sort_aux)
7542 .TP
7543 %t
7544 number of tagged messages *
7545 .TP
7546 %T
7547 current thread group sorting method ($sort_thread_groups) *
7548 .TP
7549 %u
7550 number of unread messages *
7551 .TP
7552 %v
7553 Mutt version string
7554 .TP
7555 %V
7556 currently active limit pattern, if any *
7557 .TP
7558 %>X
7559 right justify the rest of the string and pad with \(lqX\(rq
7560 .TP
7561 %|X
7562 pad to the end of the line with \(lqX\(rq
7563 .TP
7564 %*X
7565 soft\-fill with character \(lqX\(rq as pad
7566 .RE
7567 .PD 1
7568 .IP
7569 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
7570 .IP
7571 * = can be optionally printed if nonzero
7572 .IP
7573 Some of the above sequences can be used to optionally print a string
7574 if their value is nonzero. For example, you may only want to see the
7575 number of flagged messages if such messages exist, since zero is not
7576 particularly meaningful. To optionally print a string based upon one
7577 of the above sequences, the following construct is used:
7578 .IP
7579 \fB%?<sequence_char>?<optional_string>?\fP
7580 .IP
7581 where \fIsequence_char\fP is a character from the table above, and
7582 \fIoptional_string\fP is the string you would like printed if
7583 \fIsequence_char\fP is nonzero. \fIoptional_string\fP \fBmay\fP contain
7584 other sequences as well as normal text, but you may \fBnot\fP nest
7585 optional strings.
7586 .IP
7587 Here is an example illustrating how to optionally print the number of
7588 new messages in a mailbox:
7589 .IP
7590 \fB%?n?%n new messages.?\fP
7591 .IP
7592 You can also switch between two strings using the following construct:
7593 .IP
7594 \fB%?<sequence_char>?<if_string>&<else_string>?\fP
7595 .IP
7596 If the value of \fIsequence_char\fP is non\-zero, \fIif_string\fP will
7597 be expanded, otherwise \fIelse_string\fP will be expanded.
7598 .IP
7599 You can force the result of any \fBprintf(3)\fP\-like sequence to be lowercase
7600 by prefixing the sequence character with an underscore (\(lq_\(rq) sign.
7601 For example, if you want to display the local hostname in lowercase,
7602 you would use: \(lq\fB%_h\fP\(rq.
7603 .IP
7604 If you prefix the sequence character with a colon (\(lq:\(rq) character, mutt
7605 will replace any dots in the expansion by underscores. This might be helpful
7606 with IMAP folders that don't like dots in folder names.
7607
7608
7609 .TP
7610 .B status_on_top
7611 .nf
7612 Type: boolean
7613 Default: no
7614 .fi
7615 .IP
7616 Setting this variable causes the \(lqstatus bar\(rq to be displayed on
7617 the first line of the screen rather than near the bottom. If $help
7618 is \fIset\fP, too it'll be placed at the bottom.
7619
7620
7621 .TP
7622 .B strict_threads
7623 .nf
7624 Type: boolean
7625 Default: no
7626 .fi
7627 .IP
7628 If \fIset\fP, threading will only make use of the \(lqIn\-Reply\-To\(rq and
7629 \(lqReferences:\(rq fields when you $sort by message threads. By
7630 default, messages with the same subject are grouped together in
7631 \(lqpseudo threads.\(rq. This may not always be desirable, such as in a
7632 personal mailbox where you might have several unrelated messages with
7633 the subjects like \(lqhi\(rq which will get grouped together. See also
7634 $sort_re for a less drastic way of controlling this
7635 behavior.
7636
7637
7638 .TP
7639 .B suspend
7640 .nf
7641 Type: boolean
7642 Default: yes
7643 .fi
7644 .IP
7645 When \fIunset\fP, mutt won't stop when the user presses the terminal's
7646 \fIsusp\fP key, usually \(lq^Z\(rq. This is useful if you run mutt
7647 inside an xterm using a command like \(lq\fBxterm \-e mutt\fP\(rq.
7648
7649
7650 .TP
7651 .B text_flowed
7652 .nf
7653 Type: boolean
7654 Default: no
7655 .fi
7656 .IP
7657 When \fIset\fP, mutt will generate \(lqformat=flowed\(rq bodies with a content type
7658 of \(lq\fBtext/plain; format=flowed\fP\(rq.
7659 This format is easier to handle for some mailing software, and generally
7660 just looks like ordinary text. To actually make use of this format's
7661 features, you'll need support in your editor.
7662 .IP
7663 The option only controls newly composed messages. Postponed messages,
7664 resent messages, and draft messages (via \-H on the command line) will
7665 use the content\-type of the source message.
7666 .IP
7667 Note that $indent_string is ignored when this option is \fIset\fP.
7668
7669
7670 .TP
7671 .B thorough_search
7672 .nf
7673 Type: boolean
7674 Default: yes
7675 .fi
7676 .IP
7677 Affects the \fB~b\fP, \fB~B\fP, and \fB~h\fP search operations described in
7678 section \(lqpatterns\(rq. If \fIset\fP, the headers and body/attachments of
7679 messages to be searched are decoded before searching. If \fIunset\fP,
7680 messages are searched as they appear in the folder.
7681 .IP
7682 Users searching attachments or for non\-ASCII characters should \fIset\fP
7683 this value because decoding also includes MIME parsing/decoding and possible
7684 character set conversions. Otherwise mutt will attempt to match against the
7685 raw message received (for example quoted\-printable encoded or with encoded
7686 headers) which may lead to incorrect search results.
7687
7688
7689 .TP
7690 .B thread_received
7691 .nf
7692 Type: boolean
7693 Default: no
7694 .fi
7695 .IP
7696 When \fIset\fP, mutt uses the date received rather than the date sent
7697 to thread messages by subject.
7698
7699
7700 .TP
7701 .B tilde
7702 .nf
7703 Type: boolean
7704 Default: no
7705 .fi
7706 .IP
7707 When \fIset\fP, the internal\-pager will pad blank lines to the bottom of the
7708 screen with a tilde (\(lq~\(rq).
7709
7710
7711 .TP
7712 .B time_inc
7713 .nf
7714 Type: number
7715 Default: 0
7716 .fi
7717 .IP
7718 Along with $read_inc, $write_inc, and $net_inc, this
7719 variable controls the frequency with which progress updates are
7720 displayed. It suppresses updates less than $time_inc milliseconds
7721 apart. This can improve throughput on systems with slow terminals,
7722 or when running mutt on a remote system.
7723 .IP
7724 Also see the \(lqtuning\(rq section of the manual for performance considerations.
7725
7726
7727 .TP
7728 .B timeout
7729 .nf
7730 Type: number
7731 Default: 600
7732 .fi
7733 .IP
7734 When Mutt is waiting for user input either idling in menus or
7735 in an interactive prompt, Mutt would block until input is
7736 present. Depending on the context, this would prevent certain
7737 operations from working, like checking for new mail or keeping
7738 an IMAP connection alive.
7739 .IP
7740 This variable controls how many seconds Mutt will at most wait
7741 until it aborts waiting for input, performs these operations and
7742 continues to wait for input.
7743 .IP
7744 A value of zero or less will cause Mutt to never time out.
7745
7746
7747 .TP
7748 .B tmpdir
7749 .nf
7750 Type: path
7751 Default: \(lq\(rq
7752 .fi
7753 .IP
7754 This variable allows you to specify where Mutt will place its
7755 temporary files needed for displaying and composing messages. If
7756 this variable is not set, the environment variable \fB$TMPDIR\fP is
7757 used. If \fB$TMPDIR\fP is not set then \(lq\fB/var/tmp\fP\(rq is used.
7758
7759
7760 .TP
7761 .B to_chars
7762 .nf
7763 Type: string
7764 Default: \(lq +TCFL\(rq
7765 .fi
7766 .IP
7767 Controls the character used to indicate mail addressed to you. The
7768 first character is the one used when the mail is \fInot\fP addressed to your
7769 address. The second is used when you are the only
7770 recipient of the message. The third is when your address
7771 appears in the \(lqTo:\(rq header field, but you are not the only recipient of
7772 the message. The fourth character is used when your
7773 address is specified in the \(lqCc:\(rq header field, but you are not the only
7774 recipient. The fifth character is used to indicate mail that was sent
7775 by \fIyou\fP. The sixth character is used to indicate when a mail
7776 was sent to a mailing\-list you subscribe to.
7777
7778
7779 .TP
7780 .B trash
7781 .nf
7782 Type: path
7783 Default: \(lq\(rq
7784 .fi
7785 .IP
7786 If set, this variable specifies the path of the trash folder where the
7787 mails marked for deletion will be moved, instead of being irremediably
7788 purged.
7789 .IP
7790 NOTE: When you delete a message in the trash folder, it is really
7791 deleted, so that you have a way to clean the trash.
7792
7793
7794 .TP
7795 .B ts_icon_format
7796 .nf
7797 Type: string (localized)
7798 Default: \(lqM%?n?AIL&ail?\(rq
7799 .fi
7800 .IP
7801 Controls the format of the icon title, as long as \(lq$ts_enabled\(rq is set.
7802 This string is identical in formatting to the one used by
7803 \(lq$status_format\(rq.
7804
7805
7806 .TP
7807 .B ts_enabled
7808 .nf
7809 Type: boolean
7810 Default: no
7811 .fi
7812 .IP
7813 Controls whether mutt tries to set the terminal status line and icon name.
7814 Most terminal emulators emulate the status line in the window title.
7815
7816
7817 .TP
7818 .B ts_status_format
7819 .nf
7820 Type: string (localized)
7821 Default: \(lqMutt with %?m?%m messages&no messages?%?n? [%n NEW]?\(rq
7822 .fi
7823 .IP
7824 Controls the format of the terminal status line (or window title),
7825 provided that \(lq$ts_enabled\(rq has been set. This string is identical in
7826 formatting to the one used by \(lq$status_format\(rq.
7827
7828
7829 .TP
7830 .B tunnel
7831 .nf
7832 Type: string
7833 Default: \(lq\(rq
7834 .fi
7835 .IP
7836 Setting this variable will cause mutt to open a pipe to a command
7837 instead of a raw socket. You may be able to use this to set up
7838 preauthenticated connections to your IMAP/POP3/SMTP server. Example:
7839
7840 .IP
7841 .EX
7842 set tunnel=\(rqssh \-q mailhost.net /usr/local/libexec/imapd\(rq
7843
7844 .EE
7845 .IP
7846 Note: For this example to work you must be able to log in to the remote
7847 machine without having to enter a password.
7848 .IP
7849 When set, Mutt uses the tunnel for all remote connections.
7850 Please see \(lqaccount-hook\(rq in the manual for how to use different
7851 tunnel commands per connection.
7852
7853
7854 .TP
7855 .B tunnel_is_secure
7856 .nf
7857 Type: boolean
7858 Default: yes
7859 .fi
7860 .IP
7861 When \fIset\fP, Mutt will assume the $tunnel connection does not need
7862 STARTTLS to be enabled. It will also allow IMAP PREAUTH server
7863 responses inside a tunnel to proceed. This is appropriate if $tunnel
7864 uses ssh or directly invokes the server locally.
7865 .IP
7866 When \fIunset\fP, Mutt will negotiate STARTTLS according to the
7867 ssl_starttls and ssl_force_tls variables. If ssl_force_tls is
7868 set, Mutt will abort connecting if an IMAP server responds with PREAUTH.
7869 This setting is appropriate if $tunnel does not provide security and
7870 could be tampered with by attackers.
7871
7872
7873 .TP
7874 .B uncollapse_jump
7875 .nf
7876 Type: boolean
7877 Default: no
7878 .fi
7879 .IP
7880 When \fIset\fP, Mutt will jump to the next unread message, if any,
7881 when the current thread is \fIun\fPcollapsed.
7882
7883
7884 .TP
7885 .B uncollapse_new
7886 .nf
7887 Type: boolean
7888 Default: yes
7889 .fi
7890 .IP
7891 When \fIset\fP, Mutt will automatically uncollapse any collapsed
7892 thread that receives a newly delivered message. When
7893 \fIunset\fP, collapsed threads will remain collapsed. The
7894 presence of the newly delivered message will still affect index
7895 sorting, though.
7896
7897
7898 .TP
7899 .B use_8bitmime
7900 .nf
7901 Type: boolean
7902 Default: no
7903 .fi
7904 .IP
7905 \fBWarning:\fP do not set this variable unless you are using a version
7906 of sendmail which supports the \fB\-B8BITMIME\fP flag (such as sendmail
7907 8.8.x) or you may not be able to send mail.
7908 .IP
7909 When \fIset\fP, Mutt will invoke $sendmail with the \fB\-B8BITMIME\fP
7910 flag when sending 8\-bit messages to enable ESMTP negotiation.
7911
7912
7913 .TP
7914 .B use_domain
7915 .nf
7916 Type: boolean
7917 Default: yes
7918 .fi
7919 .IP
7920 When \fIset\fP, Mutt will qualify all local addresses (ones without the
7921 \(lq@host\(rq portion) with the value of $hostname. If \fIunset\fP, no
7922 addresses will be qualified.
7923
7924
7925 .TP
7926 .B use_envelope_from
7927 .nf
7928 Type: boolean
7929 Default: no
7930 .fi
7931 .IP
7932 When \fIset\fP, mutt will set the \fIenvelope\fP sender of the message.
7933 If $envelope_from_address is \fIset\fP, it will be used as the sender
7934 address. If \fIunset\fP, mutt will attempt to derive the sender from the
7935 \(lqFrom:\(rq header.
7936 .IP
7937 Note that this information is passed to sendmail command using the
7938 \fB\-f\fP command line switch. Therefore setting this option is not useful
7939 if the $sendmail variable already contains \fB\-f\fP or if the
7940 executable pointed to by $sendmail doesn't support the \fB\-f\fP switch.
7941
7942
7943 .TP
7944 .B use_from
7945 .nf
7946 Type: boolean
7947 Default: yes
7948 .fi
7949 .IP
7950 When \fIset\fP, Mutt will generate the \(lqFrom:\(rq header field when
7951 sending messages. If \fIunset\fP, no \(lqFrom:\(rq header field will be
7952 generated unless the user explicitly sets one using the \(lqmy_hdr\(rq
7953 command.
7954
7955
7956 .TP
7957 .B use_ipv6
7958 .nf
7959 Type: boolean
7960 Default: yes
7961 .fi
7962 .IP
7963 When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to
7964 contact. If this option is \fIunset\fP, Mutt will restrict itself to IPv4 addresses.
7965 Normally, the default should work.
7966
7967
7968 .TP
7969 .B user_agent
7970 .nf
7971 Type: boolean
7972 Default: no
7973 .fi
7974 .IP
7975 When \fIset\fP, mutt will add a \(lqUser\-Agent:\(rq header to outgoing
7976 messages, indicating which version of mutt was used for composing
7977 them.
7978
7979
7980 .TP
7981 .B visual
7982 .nf
7983 Type: path
7984 Default: \(lq\(rq
7985 .fi
7986 .IP
7987 Specifies the visual editor to invoke when the \(lq\fB~v\fP\(rq command is
7988 given in the built\-in editor.
7989
7990
7991 .TP
7992 .B wait_key
7993 .nf
7994 Type: boolean
7995 Default: yes
7996 .fi
7997 .IP
7998 Controls whether Mutt will ask you to press a key after an external command
7999 has been invoked by these functions: \fB<shell\-escape>\fP,
8000 \fB<pipe\-message>\fP, \fB<pipe\-entry>\fP, \fB<print\-message>\fP,
8001 and \fB<print\-entry>\fP commands.
8002 .IP
8003 It is also used when viewing attachments with \(lqauto_view\(rq, provided
8004 that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
8005 and the external program is interactive.
8006 .IP
8007 When \fIset\fP, Mutt will always ask for a key. When \fIunset\fP, Mutt will wait
8008 for a key only if the external command returned a non\-zero status.
8009
8010
8011 .TP
8012 .B weed
8013 .nf
8014 Type: boolean
8015 Default: yes
8016 .fi
8017 .IP
8018 When \fIset\fP, mutt will weed headers when displaying, forwarding,
8019 or replying to messages.
8020 .IP
8021 Also see $copy_decode_weed, $pipe_decode_weed, $print_decode_weed.
8022
8023
8024 .TP
8025 .B wrap
8026 .nf
8027 Type: number
8028 Default: 0
8029 .fi
8030 .IP
8031 When set to a positive value, mutt will wrap text at $wrap characters.
8032 When set to a negative value, mutt will wrap text so that there are $wrap
8033 characters of empty space on the right side of the terminal. Setting it
8034 to zero makes mutt wrap at the terminal width.
8035 .IP
8036 Also see $reflow_wrap.
8037
8038
8039 .TP
8040 .B wrap_headers
8041 .nf
8042 Type: number
8043 Default: 78
8044 .fi
8045 .IP
8046 This option specifies the number of characters to use for wrapping
8047 an outgoing message's headers. Allowed values are between 78 and 998
8048 inclusive.
8049 .IP
8050 \fBNote:\fP This option usually shouldn't be changed. RFC5233
8051 recommends a line length of 78 (the default), so \fBplease only change
8052 this setting when you know what you're doing\fP.
8053
8054
8055 .TP
8056 .B wrap_search
8057 .nf
8058 Type: boolean
8059 Default: yes
8060 .fi
8061 .IP
8062 Controls whether searches wrap around the end.
8063 .IP
8064 When \fIset\fP, searches will wrap around the first (or last) item. When
8065 \fIunset\fP, incremental searches will not wrap.
8066
8067
8068 .TP
8069 .B wrapmargin
8070 .nf
8071 Type: number
8072 Default: 0
8073 .fi
8074 .IP
8075 (DEPRECATED) Equivalent to setting $wrap with a negative value.
8076
8077
8078 .TP
8079 .B write_bcc
8080 .nf
8081 Type: boolean
8082 Default: no
8083 .fi
8084 .IP
8085 Controls whether mutt writes out the \(lqBcc:\(rq header when
8086 preparing messages to be sent. Some MTAs, such as Exim and
8087 Courier, do not strip the \(lqBcc:\(rq header; so it is advisable to
8088 leave this unset unless you have a particular need for the header
8089 to be in the sent message.
8090 .IP
8091 If mutt is set to deliver directly via SMTP (see $smtp_url),
8092 this option does nothing: mutt will never write out the \(lqBcc:\(rq
8093 header in this case.
8094 .IP
8095 Note this option only affects the sending of messages. Fcc'ed
8096 copies of a message will always contain the \(lqBcc:\(rq header if
8097 one exists.
8098
8099
8100 .TP
8101 .B write_inc
8102 .nf
8103 Type: number
8104 Default: 10
8105 .fi
8106 .IP
8107 When writing a mailbox, a message will be printed every
8108 $write_inc messages to indicate progress. If set to 0, only a
8109 single message will be displayed before writing a mailbox.
8110 .IP
8111 Also see the $read_inc, $net_inc and $time_inc variables and the
8112 \(lqtuning\(rq section of the manual for performance considerations.
8113
8114
8115 .\" -*-nroff-*-
8116 .SH SEE ALSO
8117 .PP
8118 .BR iconv (1),
8119 .BR iconv (3),
8120 .BR mailcap (5),
8121 .BR maildir (5),
8122 .BR mbox (5),
8123 .BR mutt (1),
8124 .BR printf (3),
8125 .BR regex (7),
8126 .BR strftime (3)
8127 .PP
8128 The Mutt Manual
8129 .PP
8130 The Mutt home page: http://www.mutt.org/
8131 .SH AUTHOR
8132 .PP
8133 Michael Elkins, and others. Use <[email protected]> to contact
8134 the developers.