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