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