« back to all changes in this revision
Viewing changes to doc/manual.txt
- browse files at revision 1.1.8
- compare with another revision
- download diff
- download tarball
- view history from revision 1.1.8
- Committer: Bazaar Package Importer
- Author(s): Christoph Berg
- Date: 2008-01-14 23:26:14 UTC
- mto: (16.1.1 sid) (1.1.11 upstream) (2.3.1 squeeze)
- mto: This revision was merged to the branch mainline in revision 16.
- Revision ID: james.westby@ubuntu.com-20080114232614-0her0yo1nr0ddddk
Tags: upstream-1.5.17+20080114
Import upstream version 1.5.17+20080114
- files added:
- doc/Muttrc
- files removed:
- Muttrc
- files modified:
- ChangeLog
added
removed
doc/manual.txt
1
1
The Mutt E-Mail Client
2
2
3
Michael Elkins
3
MichaelElkins
4
4
5
5
<me@cs.hmc.edu>
6
6
7
version 1.5.17 (2007-11-01)
7
version 1.5.17+20080114 (2008-01-14)
8
8
9
9
Abstract
10
10
62
62
10. Alternative addresses
63
63
11. Mailing lists
64
64
12. Using Multiple spool mailboxes
65
13. Defining mailboxes which receive mail
65
13. Monitoring incoming mail
66
66
14. User defined headers
67
67
15. Defining the order of headers when viewing messages
68
16. Specify default save filename
68
16. Specify default save mailbox
69
69
17. Specify default Fcc: mailbox when composing
70
70
18. Specify default save filename and default Fcc: mailbox at once
71
71
19. Change settings based upon message recipients
90
90
4. Advanced Usage
91
91
92
92
1. Regular Expressions
93
2. Patterns
93
2. Patterns: Searching, Limiting and Tagging
94
94
95
95
2.1. Pattern Modifier
96
2.2. Complex Patterns
97
2.3. Searching by Date
96
2.2. Simple Patterns
97
2.3. Complex Patterns
98
2.4. Searching by Date
98
99
99
100
3. Using Tags
100
101
4. Using Hooks
154
155
155
156
7.1. Header caching
156
157
7.2. Body caching
158
7.3. Maintenance
157
159
158
160
7. Performance tuning
159
161
451
453
3.282. thread_received
452
454
3.283. thorough_search
453
455
3.284. tilde
454
3.285. timeout
455
3.286. tmpdir
456
3.287. to_chars
457
3.288. tunnel
458
3.289. use_8bitmime
459
3.290. use_domain
460
3.291. use_envelope_from
461
3.292. use_from
462
3.293. use_idn
463
3.294. use_ipv6
464
3.295. user_agent
465
3.296. visual
466
3.297. wait_key
467
3.298. weed
468
3.299. wrap
469
3.300. wrap_search
470
3.301. wrapmargin
471
3.302. write_inc
472
3.303. write_bcc
456
3.285. time_inc
457
3.286. timeout
458
3.287. tmpdir
459
3.288. to_chars
460
3.289. tunnel
461
3.290. use_8bitmime
462
3.291. use_domain
463
3.292. use_envelope_from
464
3.293. use_from
465
3.294. use_idn
466
3.295. use_ipv6
467
3.296. user_agent
468
3.297. visual
469
3.298. wait_key
470
3.299. weed
471
3.300. wrap
472
3.301. wrap_search
473
3.302. wrapmargin
474
3.303. write_inc
475
3.304. write_bcc
473
476
474
477
4. Functions
475
478
507
510
2.11. Message forwarding/bouncing keys
508
511
3.1. Symbolic key names
509
512
4.1. Pattern modifiers
510
4.2. Date units
513
4.2. Simple search keywords
514
4.3. Date units
511
515
8.1. Command line options
512
516
8.2. Default generic function bindings
513
517
8.3. Default index function bindings
523
527
8.13. Default mix function bindings
524
528
8.14. Default editor function bindings
525
529
526
Chapter 1. Introduction
530
Chapter 1. Introduction
527
531
528
532
Table of Contents
529
533
539
543
like key bindings, keyboard macros, mail threading, regular expression searches
540
544
and a powerful pattern matching language for selecting groups of messages.
541
545
542
1. Mutt Home Page
546
1. Mutt Home Page
543
547
544
548
http://www.mutt.org/
545
549
546
2. Mailing Lists
550
2. Mailing Lists
547
551
548
552
To subscribe to one of the following mailing lists, send a message with the
549
553
word subscribe in the body to list-name-request@mutt.org.
557
561
Note: all messages posted to mutt-announce are automatically forwarded to
558
562
mutt-users, so you do not need to be subscribed to both lists.
559
563
560
3. Software Distribution Sites
564
3. Software Distribution Sites
561
565
562
566
● ftp://ftp.mutt.org/mutt/
563
567
564
568
For a list of mirror sites, please refer to http://www.mutt.org/download.html.
565
569
566
4. IRC
570
4. IRC
567
571
568
572
Visit channel #mutt on irc.freenode.net to chat with other people interested in
569
573
Mutt.
570
574
571
5. USENET
575
5. USENET
572
576
573
577
See the newsgroup comp.mail.mutt.
574
578
575
6. Copyright
579
6. Copyright
576
580
577
581
Mutt is Copyright (C) 1996-2005 Michael R. Elkins <me@cs.hmc.edu> and others
578
582
589
593
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
590
594
Street, Fifth Floor, Boston, MA 02110-1301, USA.
591
595
592
Chapter 2. Getting Started
596
Chapter 2. Getting Started
593
597
594
598
Table of Contents
595
599
629
633
command line. There are various command-line options, see either the mutt man
630
634
page or the reference.
631
635
632
1. Moving Around in Menus
633
634
Information is presented in menus, very similar to ELM, see Table 2.1, “Most
635
common navigation keys” for common keys used to navigate menus in Mutt.
636
637
Table 2.1. Most common navigation keys
636
1. Moving Around in Menus
637
638
Information is presented in menus, very similar to ELM, see Table 2.1, "Most
639
common navigation keys" for common keys used to navigate menus in Mutt.
640
641
Table 2.1. Most common navigation keys
638
642
639
643
┌───────────┬──────────────┬─────────────────────────────────────────┐
640
644
│ Key │ Function │ Description │
657
661
└───────────┴──────────────┴─────────────────────────────────────────┘
658
662
659
663
660
2. Editing Input Fields
664
2. Editing Input Fields
661
665
662
2.1. Introduction
666
2.1. Introduction
663
667
664
668
Mutt has a built-in line editor for inputting text, e.g. email addresses or
665
669
filenames. The keys used to manipulate text input are very similar to those of
666
Emacs. See Table 2.2, “Most common line editor keys” for a full reference of
670
Emacs. See Table 2.2, "Most common line editor keys" for a full reference of
667
671
available functions, their default key bindings, and short descriptions.
668
672
669
Table 2.2. Most common line editor keys
673
Table 2.2. Most common line editor keys
670
674
671
675
┌──────────────┬───────────────┬────────────────────────────────────┐
672
676
│ Key │ Function │ Description │
723
727
724
728
bind editor <delete> backspace
725
729
726
2.2. History
730
2.2. History
727
731
728
732
The number of items in the built-in editor's history is controlled by the
729
733
$history variable. You may cycle through them at an editor prompt by using the
750
754
The latter feature can be useful in macros to not clobber the history's
751
755
valuable entries with unwanted entries.
752
756
753
3. Reading Mail - The Index and Pager
757
3. Reading Mail - The Index and Pager
754
758
755
759
Similar to many other mail clients, there are two modes in which mail is read
756
760
in Mutt. The first is the index of messages in the mailbox, which is called the
759
763
760
764
The next few sections describe the functions provided in each of these modes.
761
765
762
3.1. The Message Index
766
3.1. The Message Index
763
767
764
768
Common keys used to navigate through and manage messages in the index are shown
765
in Table 2.3, “Most common message index keys”.
769
in Table 2.3, "Most common message index keys".
766
770
767
Table 2.3. Most common message index keys
771
Table 2.3. Most common message index keys
768
772
769
773
┌────────┬───────────────────────────────────────────┐
770
774
│ Key │ Description │
829
833
└────────┴───────────────────────────────────────────┘
830
834
831
835
832
3.1.1. Status Flags
836
3.1.1. Status Flags
833
837
834
838
In addition to who sent the message and the subject, a short summary of the
835
839
disposition of each message is printed beside the message number. Zero or more
908
912
909
913
message is sent to a subscribed mailing list
910
914
911
3.2. The Pager
915
3.2. The Pager
912
916
913
917
By default, Mutt uses its builtin pager to display the body of messages. The
914
918
pager is very similar to the Unix program less though not nearly as featureful.
915
919
916
Table 2.4. Most common pager keys
920
Table 2.4. Most common pager keys
917
921
918
922
┌────────┬──────────────────────────────────────────────────────────────────┐
919
923
│ Key │ Description │
942
946
└────────┴──────────────────────────────────────────────────────────────────┘
943
947
944
948
945
In addition to key bindings in Table 2.4, “Most common pager keys”, many of the
949
In addition to key bindings in Table 2.4, "Most common pager keys", many of the
946
950
functions from the index are available in the pager, such as delete-message or
947
951
copy-message (this is one advantage over using an external pager to view
948
952
messages).
958
962
Additionally, the internal pager supports the ANSI escape sequences for
959
963
character attributes. Mutt translates them into the correct color and character
960
964
settings. The sequences Mutt supports are '\e[Ps;Ps;..Ps;m' where Ps can be one
961
of the codes shown in Table 2.5, “ANSI escape sequences”.
965
of the codes shown in Table 2.5, "ANSI escape sequences".
962
966
963
Table 2.5. ANSI escape sequences
967
Table 2.5. ANSI escape sequences
964
968
965
969
┌───────────┬──────────────────────────────────────────────────────────────┐
966
970
│Escape code│ Description │
975
979
├───────────┼──────────────────────────────────────────────────────────────┤
976
980
│7 │Reverse video on │
977
981
├───────────┼──────────────────────────────────────────────────────────────┤
978
│3<color> │Foreground color is <color> (see Table 2.6, “Color sequences”)│
982
│3<color> │Foreground color is <color> (see Table 2.6, "Color sequences")│
979
983
├───────────┼──────────────────────────────────────────────────────────────┤
980
│4<color> │Background color is <color> (see Table 2.6, “Color sequences”)│
984
│4<color> │Background color is <color> (see Table 2.6, "Color sequences")│
981
985
└───────────┴──────────────────────────────────────────────────────────────┘
982
986
983
987
984
Table 2.6. Color sequences
988
Table 2.6. Color sequences
985
989
986
990
┌───────────┬───────┐
987
991
│Color code │ Color │
1010
1014
associated with color2 for your xterm, then that color will be used instead of
1011
1015
green.
1012
1016
1013
3.3. Threaded Mode
1017
3.3. Threaded Mode
1014
1018
1015
1019
When the mailbox is sorted by threads, there are a few additional functions
1016
available in the index and pager modes as shown in Table 2.7, “Most common
1017
thread mode keys”.
1020
available in the index and pager modes as shown in Table 2.7, "Most common
1021
thread mode keys".
1018
1022
1019
Table 2.7. Most common thread mode keys
1023
Table 2.7. Most common thread mode keys
1020
1024
1021
1025
┌─────┬──────────────────┬──────────────────────────────────────────────┐
1022
1026
│ Key │ Function │ Description │
1059
1063
1060
1064
See also: $strict_threads.
1061
1065
1062
3.4. Miscellaneous Functions
1066
3.4. Miscellaneous Functions
1063
1067
1064
1068
create-alias (default: a)
1065
1069
1161
1165
This function will go to the next line of non-quoted text which come after a
1162
1166
line of quoted text in the internal pager.
1163
1167
1164
4. Sending Mail
1168
4. Sending Mail
1165
1169
1166
The bindings shown in Table 2.8, “Most common mail sending keys” are available
1170
The bindings shown in Table 2.8, "Most common mail sending keys" are available
1167
1171
in the index for sending messages.
1168
1172
1169
Table 2.8. Most common mail sending keys
1173
Table 2.8. Most common mail sending keys
1170
1174
1171
1175
┌─────┬───────────┬────────────────────────────────┐
1172
1176
│ Key │ Function │ Description │
1207
1211
specified a $signature, it will be appended to the message.
1208
1212
1209
1213
Once you have finished editing the body of your mail message, you are returned
1210
to the compose menu providing the functions show in Table 2.9, “Most common
1211
compose menu keys”.
1214
to the compose menu providing the functions show in Table 2.9, "Most common
1215
compose menu keys".
1212
1216
1213
Table 2.9. Most common compose menu keys
1217
Table 2.9. Most common compose menu keys
1214
1218
1215
1219
┌─────┬─────────────────┬────────────────────────────────────────────┐
1216
1220
│ Key │ Function │ Description │
1264
1268
in that folder. The %r in $status_format will change to a 'A' to indicate that
1265
1269
you are in attach-message mode.
1266
1270
1267
4.1. Editing the message header
1271
4.1. Editing the message header
1268
1272
1269
1273
When editing the header of your outgoing message, there are a couple of special
1270
1274
features available.
1271
1275
1272
If you specify Fcc: filename Mutt will pick up filename just as if you had used
1276
If you specify Fcc:filename Mutt will pick up filename just as if you had used
1273
1277
the edit-fcc function in the compose menu.
1274
1278
1275
You can also attach files to your message by specifying Attach: filename [
1279
You can also attach files to your message by specifying Attach:filename [
1276
1280
description ] where filename is the file to attach and description is an
1277
1281
optional string to use as the description of the attached file.
1278
1282
1282
1286
1283
1287
Also see $edit_headers.
1284
1288
1285
4.2. Using Mutt with PGP
1289
4.2. Using Mutt with PGP
1286
1290
1287
1291
If you want to use PGP, you can specify
1288
1292
1310
1314
$pgp_entry_format) have obvious meanings. But some explanations on the
1311
1315
capabilities, flags, and validity fields are in order.
1312
1316
1313
The flags sequence (%f) will expand to one of the flags in Table 2.10, “PGP key
1314
menu flags”.
1317
The flags sequence (%f) will expand to one of the flags in Table 2.10, "PGP key
1318
menu flags".
1315
1319
1316
Table 2.10. PGP key menu flags
1320
Table 2.10. PGP key menu flags
1317
1321
1318
1322
┌────┬──────────────────────────────────────────────────┐
1319
1323
│Flag│ Description │
1345
1349
untrusted association, a space character means a partially trusted association,
1346
1350
and a plus character (+) indicates complete validity.
1347
1351
1348
4.3. Sending anonymous messages via mixmaster.
1352
4.3. Sending anonymous messages via mixmaster.
1349
1353
1350
1354
You may also have configured mutt to co-operate with Mixmaster, an anonymous
1351
1355
remailer. Mixmaster permits you to send your messages anonymously using a chain
1377
1381
only forward messages to other mixmaster remailers. For details on the other
1378
1382
capabilities, please have a look at the mixmaster documentation.
1379
1383
1380
4.4. Sending format=flowed messages
1384
4.4. Sending format=flowed messages
1381
1385
1382
4.4.1. Concept
1386
4.4.1. Concept
1383
1387
1384
1388
format=flowed-style messages (or f=f for short) are text/plain messages that
1385
1389
consist of paragraphs which a receiver's mail client may reformat to its own
1391
1395
standard 80x25 character cell terminal, it may be desired to let the receiver
1392
1396
decide completely how to view a message.
1393
1397
1394
4.4.2. Mutt support
1398
4.4.2. Mutt support
1395
1399
1396
1400
Mutt only supports setting the required format=flowed MIME parameter on
1397
1401
outgoing messages if the $text_flowed variable is set. It does not add the
1416
1420
not for the third: It is impossible to safely detect whether a leading >
1417
1421
character starts a quote or not.
1418
1422
1419
4.4.3. Editor considerations
1423
4.4.3. Editor considerations
1420
1424
1421
1425
As mutt provides no additional features to compose f=f messages, it's
1422
1426
completely up to the user and his editor to produce proper messages. Please
1429
1433
For example, vim provides the w flag for its formatoptions setting to assist in
1430
1434
creating f=f messages, see :help fo-table for details.
1431
1435
1432
5. Forwarding and Bouncing Mail
1436
5. Forwarding and Bouncing Mail
1433
1437
1434
1438
Bouncing and forwarding let you send an existing message to recipients that you
1435
1439
specify. Bouncing a message uses the $sendmail command to send a copy to
1436
1440
alternative addresses as if they were the message's original recipients.
1437
1441
Forwarding a message, on the other hand, allows you to modify the message
1438
1442
before it is resent (for example, by adding your own comments). The default key
1439
bindings are shown in Table 2.11, “Message forwarding/bouncing keys”.
1443
bindings are shown in Table 2.11, "Message forwarding/bouncing keys".
1440
1444
1441
Table 2.11. Message forwarding/bouncing keys
1445
Table 2.11. Message forwarding/bouncing keys
1442
1446
1443
1447
┌───┬────────┬───────────────────────┐
1444
1448
│Key│Function│ Description │
1463
1467
Editing the message to forward follows the same procedure as sending or
1464
1468
replying to a message does.
1465
1469
1466
6. Postponing Mail
1470
6. Postponing Mail
1467
1471
1468
1472
At times it is desirable to delay sending a message that you have already begun
1469
1473
to compose. When the postpone-message function is used in the compose menu, the
1484
1488
1485
1489
See also the $postpone quad-option.
1486
1490
1487
Chapter 3. Configuration
1491
Chapter 3. Configuration
1488
1492
1489
1493
Table of Contents
1490
1494
1500
1504
10. Alternative addresses
1501
1505
11. Mailing lists
1502
1506
12. Using Multiple spool mailboxes
1503
13. Defining mailboxes which receive mail
1507
13. Monitoring incoming mail
1504
1508
14. User defined headers
1505
1509
15. Defining the order of headers when viewing messages
1506
16. Specify default save filename
1510
16. Specify default save mailbox
1507
1511
17. Specify default Fcc: mailbox when composing
1508
1512
18. Specify default save filename and default Fcc: mailbox at once
1509
1513
19. Change settings based upon message recipients
1547
1551
is the same which is visible using the ``-v'' command line switch or using the
1548
1552
show-version key (default: V) from the index menu.
1549
1553
1550
1. Syntax of Initialization Files
1554
1. Syntax of Initialization Files
1551
1555
1552
1556
An initialization file consists of a series of commands. Each line of the file
1553
1557
may contain one or more commands. When multiple commands are used, they must be
1607
1611
The commands understood by mutt are explained in the next paragraphs. For a
1608
1612
complete list, see the command reference.
1609
1613
1610
2. Address groups
1614
2. Address groups
1611
1615
1612
Usage: group [ -group name [ ... ] ] [ -rx EXPR [ ... ] ] [ -addr EXPR [ ... ]
1613
]
1616
Usage: group [ -groupname [ ... ] ] [ -rxEXPR [ ... ] ] [ -addrEXPR [ ... ] ]
1614
1617
1615
1618
group is used to directly add either addresses or regular expressions to the
1616
1619
specified group or groups. The different categories of arguments to the group
1624
1627
Once defined, these address groups can be used in patterns to search for and
1625
1628
limit the display to messages matching a group.
1626
1629
1627
Usage: ungroup [ -group name [ ... ] ] [ * | [ [ -rx EXPR [ ... ] ] [ -addr
1628
EXPR [ ... ] ] ]
1630
Usage: ungroup [ -groupname [ ... ] ] [ * | [ [ -rxEXPR [ ... ] ] [ -addrEXPR [
1631
... ] ] ]
1629
1632
1630
1633
ungroup is used to remove addresses or regular expressions from the specified
1631
1634
group or groups. The syntax is similar to the group command, however the
1632
1635
special character * can be used to empty a group of all of its contents.
1633
1636
1634
3. Defining/Using aliases
1637
3. Defining/Using aliases
1635
1638
1636
Usage: alias [ -group name [ ... ] ] key address [ , address, ... ]
1639
Usage: alias [ -groupname [ ... ] ] keyaddress [ , address, ... ]
1637
1640
1638
1641
It's usually very cumbersome to remember or type out the address of someone you
1639
1642
are communicating with. Mutt allows you to create ``aliases'' which map a short
1647
1650
1648
1651
To remove an alias or aliases (``*'' means all aliases):
1649
1652
1650
unalias [ * | key ... ]
1653
unalias [ * | key... ]
1651
1654
1652
1655
alias muttdude me@cs.hmc.edu (Michael Elkins)
1653
1656
alias theguys manny, moe, jack
1658
1661
can have all aliases defined in your muttrc.
1659
1662
1660
1663
On the other hand, the create-alias function can use only one file, the one
1661
pointed to by the $alias_file variable (which is ˜/.muttrc by default). This
1664
pointed to by the $alias_file variable (which is ~/.muttrc by default). This
1662
1665
file is not special either, in the sense that Mutt will happily append aliases
1663
1666
to any file, but in order for the new aliases to take effect you need to
1664
1667
explicitly source this file too.
1684
1687
select-entry key (default: RET), and use the exit key (default: q) to return to
1685
1688
the address prompt.
1686
1689
1687
4. Changing the default key bindings
1690
4. Changing the default key bindings
1688
1691
1689
Usage: bind map key function
1692
Usage: bindmapkeyfunction
1690
1693
1691
1694
This command allows you to change the default key bindings (operation invoked
1692
1695
when pressing a key).
1751
1754
well as \C is ignored, so that \CA, \Ca, \cA and \ca are all equivalent. An
1752
1755
alternative form is to specify the key as a three digit octal number prefixed
1753
1756
with a ``\'' (for example \177 is equivalent to \c?). In addition, key may be a
1754
symbolic name as shown in Table 3.1, “Symbolic key names”.
1757
symbolic name as shown in Table 3.1, "Symbolic key names".
1755
1758
1756
Table 3.1. Symbolic key names
1759
Table 3.1. Symbolic key names
1757
1760
1758
1761
┌─────────────┬───────────────────┐
1759
1762
│Symbolic name│ Meaning │
1812
1815
list of functions, see the reference. The special function noop unbinds the
1813
1816
specified key sequence.
1814
1817
1815
5. Defining aliases for character sets
1816
1817
1818
Usage: charset-hook alias charset
1819
Usage: iconv-hook charset local-charset
1818
5. Defining aliases for character sets
1819
1820
1821
Usage: charset-hook alias charset
1822
Usage: iconv-hook charset local-charset
1820
1823
1821
1824
The charset-hook command defines an alias for a character set. This is useful
1822
1825
to properly display messages which are tagged with a character set name not
1826
1829
is helpful when your systems character conversion library insists on using
1827
1830
strange, system-specific names for character sets.
1828
1831
1829
6. Setting variables based upon mailbox
1832
6. Setting variables based upon mailbox
1830
1833
1831
Usage: folder-hook [!]regexp command
1834
Usage: folder-hook [!]regexpcommand
1832
1835
1833
1836
It is often desirable to change settings based on which mailbox you are
1834
1837
reading. The folder-hook command provides a method by which you can execute any
1851
1854
1852
1855
folder-hook . set sort=date-sent
1853
1856
1854
7. Keyboard macros
1857
7. Keyboard macros
1855
1858
1856
Usage: macro menu key sequence [ description ]
1859
Usage: macromenukeysequence [ description ]
1857
1860
1858
1861
Macros are useful when you would like a single key to perform a series of
1859
1862
actions. When you press key in menu menu, Mutt will behave as if you had typed
1883
1886
Note: Macro definitions (if any) listed in the help screen(s), are silently
1884
1887
truncated at the screen width, and are not wrapped.
1885
1888
1886
8. Using color and mono video attributes
1887
1888
1889
Usage: color object foreground background [ regexp ]
1890
Usage: color index foreground background pattern
1891
Usage: uncolor index pattern [ pattern ... ]
1889
8. Using color and mono video attributes
1890
1891
1892
Usage: color object foreground background [ regexp ]
1893
Usage: color index foreground background pattern
1894
Usage: uncolor index pattern [ pattern ... ]
1892
1895
1893
1896
If your terminal supports color, you can spice up Mutt by creating your own
1894
1897
color scheme. To define the color of an object (type of information), you must
1929
1932
1930
1933
● status (mode lines used to display info about the mailbox or message)
1931
1934
1932
● tilde (the ``˜'' used to pad blank lines in the pager)
1935
● tilde (the ``~'' used to pad blank lines in the pager)
1933
1936
1934
1937
● tree (thread tree drawn in the message index and attachment menu)
1935
1938
1977
1980
command for it to be removed. The pattern ``*'' is a special token which means
1978
1981
to clear the color index list of all entries.
1979
1982
1980
Mutt also recognizes the keywords color0, color1, …, colorN-1 (N being the
1983
Mutt also recognizes the keywords color0, color1, ..., colorN-1 (N being the
1981
1984
number of colors supported by your terminal). This is useful when you remap the
1982
1985
colors for your display (for example by changing the color associated with
1983
1986
color2 for your xterm), since color names may then lose their normal meaning.
1986
1989
attributes through the use of the ``mono'' command:
1987
1990
1988
1991
1989
Usage: mono <object> <attribute> [ regexp ]
1990
Usage: mono index attribute pattern
1991
Usage: unmono index pattern [ pattern ... ]
1992
Usage: mono <object> <attribute> [ regexp ]
1993
Usage: mono index attribute pattern
1994
Usage: unmono index pattern [ pattern ... ]
1992
1995
1993
1996
where attribute is one of the following:
1994
1997
2002
2005
2003
2006
● standout
2004
2007
2005
9. Ignoring (weeding) unwanted message headers
2008
9. Ignoring (weeding) unwanted message headers
2006
2009
2007
Usage: [un]ignore pattern [ pattern ... ]
2010
Usage: [un]ignorepattern [ pattern ... ]
2008
2011
2009
2012
Messages often have many header fields added by automatic processing systems,
2010
2013
or which may not seem useful to display on the screen. This command allows you
2028
2031
unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
2029
2032
unignore posted-to:
2030
2033
2031
10. Alternative addresses
2034
10. Alternative addresses
2032
2035
2033
Usage: [un]alternates [ -group name [ ... ] ] regexp [ regexp ... ]
2036
Usage: [un]alternates [ -groupname [ ... ] ] regexp [ regexp ... ]
2034
2037
2035
2038
With various functions, mutt will treat messages differently, depending on
2036
2039
whether you sent them or whether you received them from someone else. For
2045
2048
It takes a list of regular expressions, each of which can identify an address
2046
2049
under which you receive e-mail.
2047
2050
2051
As addresses are matched using regular expressions and not exact strict
2052
comparisons, you should make sure you specify your addresses as precise as
2053
possible to avoid mismatches. For example, if you specify:
2054
2055
alternates user@example
2056
2057
mutt will consider ``some-user@example'' as being your address, too which may
2058
not be desired. As a solution, in such cases addresses should be specified as:
2059
2060
alternates '^user@example$'
2061
2048
2062
The -group flag causes all of the subsequent regular expressions to be added to
2049
2063
the named group.
2050
2064
2059
2073
be removed. If the regexp for unalternates is ``*'', all entries on alternates
2060
2074
will be removed.
2061
2075
2062
11. Mailing lists
2063
2064
2065
Usage: [un]lists [ -group name [ ... ] ] regexp [ regexp ... ]
2066
Usage: [un]subscribe [ -group name [ ... ] ] regexp [ regexp ... ]
2076
11. Mailing lists
2077
2078
2079
Usage: [un]lists [ -group name [ ... ] ] regexp [ regexp ... ]
2080
Usage: [un]subscribe [ -group name [ ... ] ] regexp [ regexp ... ]
2067
2081
2068
2082
Mutt has a few nice features for handling mailing lists. In order to take
2069
2083
advantage of them, you must specify which addresses belong to mailing lists,
2105
2119
To remove a mailing list from the list of subscribed mailing lists, but keep it
2106
2120
on the list of known mailing lists, use ``unsubscribe''.
2107
2121
2108
12. Using Multiple spool mailboxes
2122
12. Using Multiple spool mailboxes
2109
2123
2110
Usage: mbox-hook [!]pattern mailbox
2124
Usage: mbox-hook [!]patternmailbox
2111
2125
2112
2126
This command is used to move read messages from a specified mailbox to a
2113
2127
different mailbox automatically when you quit or change folders. pattern is a
2117
2131
Unlike some of the other hook commands, only the first matching pattern is used
2118
2132
(it is not possible to save read mail in more than a single mailbox).
2119
2133
2120
13. Defining mailboxes which receive mail
2134
13. Monitoring incoming mail
2121
2135
2122
Usage: [un]mailboxes [!]filename [ filename ... ]
2136
Usage: [un]mailboxesfolder [ folder ... ]
2123
2137
2124
2138
This command specifies folders which can receive mail and which will be checked
2125
2139
for new messages. By default, the main menu status bar displays how many of
2126
2140
these folders have new messages.
2127
2141
2142
folder can either be a local file or directory (Mbox/Mmdf or Maildir/Mh). If
2143
Mutt was built with POP and/or IMAP support, folder can also be a POP/IMAP
2144
folder URL. The URL syntax is described in Section 1.2, "URL syntax", POP and
2145
IMAP are described in Section 3, "POP3 Support" and Section 4, "IMAP Support"
2146
respectively.
2147
2128
2148
When changing folders, pressing space will cycle through folders with new mail.
2129
2149
2130
2150
Pressing TAB in the directory browser will bring up a menu showing the files
2135
2155
The ``unmailboxes'' command is used to remove a token from the list of folders
2136
2156
which receive mail. Use ``unmailboxes *'' to remove all tokens.
2137
2157
2138
Note: new mail is detected by comparing the last modification time to the last
2139
access time. Utilities like biff or frm or any other program which accesses the
2140
mailbox might cause Mutt to never detect new mail for that mailbox if they do
2141
not properly reset the access time. Backup tools are another common reason for
2142
updated access times.
2143
2144
Note: the filenames in the mailboxes command are resolved when the command is
2158
Note: the folders in the mailboxes command are resolved when the command is
2145
2159
executed, so if these names contain shortcut characters (such as ``='' and ``!
2146
2160
''), any variable definition that affect these characters (like $folder and
2147
$spoolfile) should be executed before the mailboxes command.
2148
2149
14. User defined headers
2150
2151
Usage: my_hdr string unmy_hdr field [ field ... ]
2161
$spoolfile) should be executed before the mailboxes command. If none of these
2162
shorcuts are used, a local path should be absolute as otherwise mutt tries to
2163
find it within the current working directory from where mutt was started which
2164
may not always be desired.
2165
2166
For local folders, new mail is detected by comparing access and/or modification
2167
times of files and folders. The interval in which Mutt checks for new mail is
2168
defined by $mail_check.
2169
2170
Special care is required with Mbox and Mmdf folders as Mutt assumes such a
2171
folder has new mail if it wasn't accessed after it was last modified. Utilities
2172
like biff or frm or any other program which accesses the mailbox might cause
2173
Mutt to never detect new mail for that mailbox if they do not properly reset
2174
the access time. Backup tools are another common reason for updated access
2175
times.
2176
2177
14. User defined headers
2178
2179
Usage: my_hdrstringunmy_hdrfield [ field ... ]
2152
2180
2153
2181
The ``my_hdr'' command allows you to create your own header fields which will
2154
2182
be added to every message you send.
2156
2184
For example, if you would like to add an ``Organization:'' header field to all
2157
2185
of your outgoing messages, you can put the command
2158
2186
2159
“my_hdr Organization: A Really Big Company, Anytown, USA”
2187
"my_hdr Organization: A Really Big Company, Anytown, USA"
2160
2188
2161
2189
in your .muttrc.
2162
2190
2174
2202
remove. For example, to remove all ``To'' and ``Cc'' header fields, you could
2175
2203
use:
2176
2204
2177
“unmy_hdr to cc”
2178
2179
15. Defining the order of headers when viewing messages
2180
2181
Usage: hdr_order header1 header2 header3
2205
"unmy_hdr to cc"
2206
2207
15. Defining the order of headers when viewing messages
2208
2209
Usage: hdr_orderheader1header2header3
2182
2210
2183
2211
With this command, you can specify an order in which mutt will attempt to
2184
2212
present headers to you when viewing messages.
2188
2216
2189
2217
hdr_order From Date: From: To: Cc: Subject:
2190
2218
2191
16. Specify default save filename
2192
2193
Usage: save-hook [!]pattern filename
2194
2195
This command is used to override the default filename used when saving
2196
messages. filename will be used as the default filename if the message is From:
2197
an address matching regexp or if you are the author and the message is
2198
addressed to: something matching regexp.
2199
2200
See Message Matching in Hooks for information on the exact format of pattern.
2219
16. Specify default save mailbox
2220
2221
Usage: save-hook [!]patternmailbox
2222
2223
This command is used to override the default mailbox used when saving messages.
2224
mailbox will be used as the default if the message matches pattern, see Message
2225
Matching in Hooks for information on the exact format.
2226
2227
To provide more flexibility and good defaults, Mutt applies the expandos of
2228
$index_format to mailbox after it was expanded.
2201
2229
2202
2230
Examples:
2203
2231
2232
# default: save all to ~/Mail/<author name>
2233
save-hook . ~/Mail/%F
2234
# save from me@turing.cs.hmc.edu/me@cs.hmc.edu to $folder/elinks
2204
2235
save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
2236
# save from aol.com to $folder/spam
2205
2237
save-hook aol\\.com$ +spam
2206
2238
2207
2239
Also see the fcc-save-hook command.
2208
2240
2209
17. Specify default Fcc: mailbox when composing
2241
17. Specify default Fcc: mailbox when composing
2210
2242
2211
Usage: fcc-hook [!]pattern mailbox
2243
Usage: fcc-hook [!]patternmailbox
2212
2244
2213
2245
This command is used to save outgoing mail in a mailbox other than $record.
2214
2246
Mutt searches the initial list of message recipients for the first matching
2215
2247
regexp and uses mailbox as the default Fcc: mailbox. If no match is found the
2216
2248
message will be saved to $record mailbox.
2217
2249
2250
To provide more flexibility and good defaults, Mutt applies the expandos of
2251
$index_format to mailbox after it was expanded.
2252
2218
2253
See Message Matching in Hooks for information on the exact format of pattern.
2219
2254
2220
2255
Example: fcc-hook [@.]aol\\.com$ +spammers
2222
2257
The above will save a copy of all messages going to the aol.com domain to the
2223
2258
`+spammers' mailbox by default. Also see the fcc-save-hook command.
2224
2259
2225
18. Specify default save filename and default Fcc: mailbox at once
2260
18. Specify default save filename and default Fcc: mailbox at once
2226
2261
2227
Usage: fcc-save-hook [!]pattern mailbox
2262
Usage: fcc-save-hook [!]patternmailbox
2228
2263
2229
2264
This command is a shortcut, equivalent to doing both a fcc-hook and a save-hook
2230
with its arguments.
2231
2232
19. Change settings based upon message recipients
2233
2234
2235
Usage: reply-hook [!]pattern command
2236
Usage: send-hook [!]pattern command
2237
Usage: send2-hook [!]pattern command
2265
with its arguments, including %-expansion on mailbox according to $index_format
2266
.
2267
2268
19. Change settings based upon message recipients
2269
2270
2271
Usage: reply-hook [!]pattern command
2272
Usage: send-hook [!]pattern command
2273
Usage: send2-hook [!]pattern command
2238
2274
2239
2275
These commands can be used to execute arbitrary configuration commands based
2240
2276
upon recipients of the message. pattern is a regular expression matching the
2241
2277
desired address. command is executed when regexp matches recipients of the
2242
2278
message.
2243
2279
2244
reply-hook is matched against the message you are replying to, instead of the
2280
reply-hook is matched against the message you are replyingto, instead of the
2245
2281
message you are sending. send-hook is matched against all messages, both new
2246
and replies. Note: reply-hooks are matched before the send-hook, regardless of
2282
and replies. Note:reply-hooks are matched before the send-hook, regardless of
2247
2283
the order specified in the user's configuration file.
2248
2284
2249
2285
send2-hook is matched every time a message is changed, either by editing it, or
2269
2305
recipient headers, or the message's subject, don't have any effect on the
2270
2306
current message when executed from a send-hook.
2271
2307
2272
20. Change settings before formatting a message
2308
20. Change settings before formatting a message
2273
2309
2274
Usage: message-hook [!]pattern command
2310
Usage: message-hook [!]patterncommand
2275
2311
2276
2312
This command can be used to execute arbitrary configuration commands before
2277
2313
viewing or formatting a message based upon information about the message.
2286
2322
message-hook ~A 'set pager=builtin'
2287
2323
message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
2288
2324
2289
21. Choosing the cryptographic key of the recipient
2325
21. Choosing the cryptographic key of the recipient
2290
2326
2291
Usage: crypt-hook pattern keyid
2327
Usage: crypt-hookpatternkeyid
2292
2328
2293
2329
When encrypting messages with PGP or OpenSSL, you may want to associate a
2294
2330
certain key with a given e-mail address automatically, either because the
2300
2336
The meaning of "key id" is to be taken broadly in this context: You can either
2301
2337
put a numerical key ID here, an e-mail address, or even just a real name.
2302
2338
2303
22. Adding key sequences to the keyboard buffer
2339
22. Adding key sequences to the keyboard buffer
2304
2340
2305
Usage: push string
2341
Usage: pushstring
2306
2342
2307
2343
This command adds the named string to the keyboard buffer. The string may
2308
2344
contain control characters, key names and function names like the sequence
2313
2349
2314
2350
folder-hook . 'push <collapse-all>'
2315
2351
2316
23. Executing functions
2352
23. Executing functions
2317
2353
2318
Usage: exec function [ function ... ]
2354
Usage: execfunction [ function ... ]
2319
2355
2320
2356
This command can be used to execute any function. Functions are listed in the
2321
2357
function reference. ``exec function'' is equivalent to ``push <function>''.
2322
2358
2323
24. Message Scoring
2324
2325
2326
Usage: score pattern value
2327
Usage: unscore pattern [ pattern ... ]
2359
24. Message Scoring
2360
2361
2362
Usage: score pattern value
2363
Usage: unscore pattern [ pattern ... ]
2328
2364
2329
2365
The score commands adds value to a message's score if pattern matches it.
2330
2366
pattern is a string in the format described in the patterns section (note: For
2331
2367
efficiency reasons, patterns which scan information not available in the index,
2332
such as ˜b, ˜B or ˜h, may not be used). value is a positive or negative
2368
such as ~b, ~B or ~h, may not be used). value is a positive or negative
2333
2369
integer. A message's final score is the sum total of all matching score
2334
2370
entries. However, you may optionally prefix value with an equal sign (=) to
2335
2371
cause evaluation to stop at a particular entry if there is a match. Negative
2339
2375
same pattern specified in the score command for it to be removed. The pattern
2340
2376
``*'' is a special token which means to clear the list of all score entries.
2341
2377
2342
25. Spam detection
2343
2344
2345
Usage: spam pattern format
2346
Usage: nospam pattern
2378
25. Spam detection
2379
2380
2381
Usage: spam pattern format
2382
Usage: nospam pattern
2347
2383
2348
2384
Mutt has generalized support for external spam-scoring filters. By defining
2349
2385
your spam patterns with the spam and nospam commands, you can limit, search,
2388
2424
get only the last one to match.
2389
2425
2390
2426
The spam tag is what will be displayed in the index when you use %H in the
2391
$index_format variable. It's also the string that the ˜H pattern-matching
2427
$index_format variable. It's also the string that the ~H pattern-matching
2392
2428
expression matches against for search and limit functions. And it's what
2393
2429
sorting by spam attribute will use as a sort key.
2394
2430
2426
2462
2427
2463
spam "^From: .*MAILER-DAEMON" "999"
2428
2464
2429
26. Setting and Querying Variables
2465
26. Setting and Querying Variables
2430
2466
2431
26.1. Commands
2467
26.1. Commands
2432
2468
2433
2469
The following commands are available to manipulate and query variables:
2434
2470
2435
2471
2436
Usage: set [no|inv]variable[=value] [ variable ... ]
2437
Usage: toggle variable [variable ... ]
2438
Usage: unset variable [variable ... ]
2439
Usage: reset variable [variable ... ]
2472
Usage: set [no|inv]variable[=value] [ variable ... ]
2473
Usage: toggle variable [variable ... ]
2474
Usage: unset variable [variable ... ]
2475
Usage: reset variable [variable ... ]
2440
2476
2441
2477
This command is used to set (and unset) configuration variables. There are four
2442
2478
basic types of variables: boolean, number, string and quadoption. boolean
2481
2517
With the reset command there exists the special variable ``all'', which allows
2482
2518
you to reset all variables to their system defaults.
2483
2519
2484
26.2. User-defined variables
2520
26.2. User-defined variables
2485
2521
2486
26.2.1. Introduction
2522
26.2.1. Introduction
2487
2523
2488
2524
Along with the variables listed in the Configuration variables section, mutt
2489
2525
supports user-defined variables with names starting with my_ as in, for
2496
2532
variables are (except for the shell-escape command), this feature can be used
2497
2533
to make configuration files more readable.
2498
2534
2499
26.2.2. Examples
2535
26.2.2. Examples
2500
2536
2501
2537
The following example defines and uses the variable my_cfgdir to abbreviate the
2502
2538
calls of the source command:
2535
2571
Note that there is a space between <enter-command> and the set configuration
2536
2572
command, preventing mutt from recording the macro's commands into its history.
2537
2573
2538
27. Reading initialization commands from another file
2574
27. Reading initialization commands from another file
2539
2575
2540
Usage: source filename
2576
Usage: sourcefilename
2541
2577
2542
2578
This command allows the inclusion of initialization commands from other files.
2543
For example, I place all of my aliases in ˜/.mail_aliases so that I can make my
2544
˜/.muttrc readable and keep my aliases private.
2579
For example, I place all of my aliases in ~/.mail_aliases so that I can make my
2580
~/.muttrc readable and keep my aliases private.
2545
2581
2546
If the filename begins with a tilde (``˜''), it will be expanded to the path of
2582
If the filename begins with a tilde (``~''), it will be expanded to the path of
2547
2583
your home directory.
2548
2584
2549
2585
If the filename ends with a vertical bar (|), then filename is considered to be
2550
an executable program from which to read input (eg. source ˜/bin/myscript|).
2586
an executable program from which to read input (eg. source ~/bin/myscript|).
2551
2587
2552
28. Removing hooks
2588
28. Removing hooks
2553
2589
2554
2590
Usage: unhook [ * | hook-type ]
2555
2591
2558
2594
can remove all hooks of a specific type by saying something like unhook
2559
2595
send-hook.
2560
2596
2561
29. Format Strings
2597
29. Format Strings
2562
2598
2563
29.1. Basic usage
2599
29.1. Basic usage
2564
2600
2565
2601
Format strings are a general concept you'll find in several locations through
2566
2602
the mutt configuration, especially in the $index_format", $pager_format",
2584
2620
out with spaces. If a decimal point and another number follow, that's the
2585
2621
maximum space allowable -- the string will not be permitted to exceed that
2586
2622
width, no matter its natural size. Each of these three elements is optional, so
2587
that all these are legal format strings: %-12s %4c %.15F %-12.15L
2623
that all these are legal format strings: %-12s%4c%.15F%-12.15L
2588
2624
2589
2625
Mutt adds some other modifiers to format strings. If you use an equals symbol
2590
2626
(=) as a numeric prefix (like the minus above), it will force the string to be
2600
2636
And if you use a colon (``:''), it will replace all decimal points with
2601
2637
underlines.
2602
2638
2603
29.2. Filters
2639
29.2. Filters
2604
2640
2605
2641
Any format string ending in a vertical bar (``|'') will be expanded and piped
2606
2642
through the first word in the string, using spaces as separator. The string
2621
2657
subdirectory of the mutt documentation: it can be used as filter for
2622
2658
$status_format to set the current terminal's title, if supported.
2623
2659
2624
Chapter 4. Advanced Usage
2660
Chapter 4. Advanced Usage
2625
2661
2626
2662
Table of Contents
2627
2663
2628
2664
1. Regular Expressions
2629
2. Patterns
2665
2. Patterns: Searching, Limiting and Tagging
2630
2666
2631
2667
2.1. Pattern Modifier
2632
2.2. Complex Patterns
2633
2.3. Searching by Date
2668
2.2. Simple Patterns
2669
2.3. Complex Patterns
2670
2.4. Searching by Date
2634
2671
2635
2672
3. Using Tags
2636
2673
4. Using Hooks
2649
2686
10. Delivery Status Notification (DSN) Support
2650
2687
11. Start a WWW Browser on URLs (EXTERNAL)
2651
2688
2652
1. Regular Expressions
2689
1. Regular Expressions
2653
2690
2654
2691
All string patterns in Mutt including those in more complex patterns must be
2655
2692
specified using regular expressions (regexp) in the ``POSIX extended'' syntax
2847
2884
Please note however that these operators are not defined by POSIX, so they may
2848
2885
or may not be available in stock libraries on various systems.
2849
2886
2850
2. Patterns
2887
2. Patterns: Searching, Limiting and Tagging
2851
2888
2852
2889
Many of Mutt's commands allow you to specify a pattern to match (limit,
2853
tag-pattern, delete-pattern, etc.). Table 4.1, “Pattern modifiers” shows
2890
tag-pattern, delete-pattern, etc.). Table 4.1, "Pattern modifiers" shows
2854
2891
several ways select messages.
2855
2892
2856
Table 4.1. Pattern modifiers
2893
Table 4.1. Pattern modifiers
2857
2894
2858
2895
┌─────────┬───────────────────────────────────────────────────────────────────┐
2859
2896
│ Pattern │ Description │
2973
3010
patterns will strip one level of backslash (\), which is normally used for
2974
3011
quoting. If it is your intention to use a backslash in the regular expression,
2975
3012
you will need to use two backslashes instead (\\). You can force mutt to treat
2976
EXPR as a simple string instead of a regular expression by using = instead of ˜
3013
EXPR as a simple string instead of a regular expression by using = instead of ~
2977
3014
in the pattern name. For example, =b *.* will find all messages that contain
2978
3015
the literal string '*.*'. Simple string matches are less powerful than regular
2979
3016
expressions but can be considerably faster. This is especially true for IMAP
2985
3022
2986
3023
*) The forms <[MAX], >[MIN], [MIN]- and -[MAX] are allowed, too.
2987
3024
2988
2.1. Pattern Modifier
3025
2.1. Pattern Modifier
2989
3026
2990
3027
Note that patterns matching 'lists' of addresses (notably c,C,p,P and t) match
2991
3028
if there is at least one match in the whole list. If you want to make sure that
2994
3031
2995
3032
^~C \.de$
2996
3033
2997
2.2. Complex Patterns
3034
2.2. Simple Patterns
3035
3036
Mutt supports two versions of so called ``simple searches'' which are issued if
3037
the query entered for searching, limiting and similar operations does not seem
3038
to be a valid pattern (i.e. it does not contain one of these characters: ``~'',
3039
``='' or ``%''). If the query is supposed to contain one of these special
3040
characters, they must be escaped by prepending a backslash (``\'').
3041
3042
The first type is by checking whether the query string equals a keyword
3043
case-insensitively from Table 4.2, "Simple search keywords": If that is the
3044
case, Mutt will use the shown pattern modifier instead. If a keyword would
3045
conflict with your search keyword, you need to turn it into a regular
3046
expression to avoid matching the keyword table. For example, if you want to
3047
find all messages matching ``flag'' (using $simple_search, see below but not
3048
meaning flagged messages) simply search for ``[f]lag''.
3049
3050
Table 4.2. Simple search keywords
3051
3052
┌───────┬─────────────────┐
3053
│Keyword│Pattern modifier │
3054
├───────┼─────────────────┤
3055
│all │~A │
3056
├───────┼─────────────────┤
3057
│. │~A │
3058
├───────┼─────────────────┤
3059
│^ │~A │
3060
├───────┼─────────────────┤
3061
│del │~D │
3062
├───────┼─────────────────┤
3063
│flag │~F │
3064
├───────┼─────────────────┤
3065
│new │~N │
3066
├───────┼─────────────────┤
3067
│old │~O │
3068
├───────┼─────────────────┤
3069
│repl │~Q │
3070
├───────┼─────────────────┤
3071
│read │~R │
3072
├───────┼─────────────────┤
3073
│tag │~T │
3074
├───────┼─────────────────┤
3075
│unread │~U │
3076
└───────┴─────────────────┘
3077
3078
3079
The second type of simple search is to build a complex search pattern using
3080
$simple_search as a template. Mutt will insert your query properly quoted and
3081
search for the composed complex query.
3082
3083
2.3. Complex Patterns
2998
3084
2999
3085
Logical AND is performed by specifying more than one criterion. For example:
3000
3086
3033
3119
~f "me@(mutt\.org|cs\.hmc\.edu)"
3034
3120
3035
3121
Without the quotes, the parenthesis wouldn't end. This would be seperated to
3036
two OR'd patterns: ˜f me@(mutt\.org and cs\.hmc\.edu). They are never what you
3122
two OR'd patterns: ~f me@(mutt\.org and cs\.hmc\.edu). They are never what you
3037
3123
want.
3038
3124
3039
2.3. Searching by Date
3125
2.4. Searching by Date
3040
3126
3041
3127
Mutt supports two types of dates, absolute and relative.
3042
3128
3053
3139
messages sent on the given date will be selected.
3054
3140
3055
3141
Error Margins. You can add error margins to absolute dates. An error margin is
3056
a sign (+ or -), followed by a digit, followed by one of the units in
3057
Table 4.2, “Date units”. As a special case, you can replace the sign by a ``*''
3142
a sign (+ or -), followed by a digit, followed by one of the units in Table
3143
4.3, "Date units". As a special case, you can replace the sign by a ``*''
3058
3144
character, which is equivalent to giving identical plus and minus error
3059
3145
margins.
3060
3146
3061
Table 4.2. Date units
3147
Table 4.3. Date units
3062
3148
3063
3149
┌────┬────────────┐
3064
3150
│Unit│Description │
3088
3174
3089
3175
● =offset (messages exactly offset units old)
3090
3176
3091
offset is specified as a positive number with one of the units from Table 4.2,
3092
“Date units”.
3177
offset is specified as a positive number with one of the units from Table 4.3,
3178
"Date units".
3093
3179
3094
3180
Example: to select messages less than 1 month old, you would use
3095
3181
3099
3185
unless you change the setting of your $index_format to include a %[...] format,
3100
3186
these are not the dates shown in the main index.
3101
3187
3102
3. Using Tags
3188
3. Using Tags
3103
3189
3104
3190
Sometimes it is desirable to perform an operation on a group of messages all at
3105
3191
once rather than one at a time. An example might be to save messages to a
3122
3208
``end-cond'' operator; after this operator the rest of the macro will be
3123
3209
executed as normal.
3124
3210
3125
4. Using Hooks
3211
4. Using Hooks
3126
3212
3127
3213
A hook is a concept borrowed from the EMACS editor which allows you to execute
3128
3214
arbitrary commands before performing some operation. For example, you may wish
3154
3240
send-hook . 'unmy_hdr From:'
3155
3241
send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
3156
3242
3157
4.1. Message Matching in Hooks
3243
4.1. Message Matching in Hooks
3158
3244
3159
3245
Hooks that act upon messages (message-hook, reply-hook, send-hook, send2-hook,
3160
3246
save-hook, fcc-hook) are evaluated in a slightly different manner. For the
3182
3268
pattern is translated at the time the hook is declared, so the value of
3183
3269
$default_hook that is in effect at that time will be used.
3184
3270
3185
5. External Address Queries
3271
5. External Address Queries
3186
3272
3187
3273
Mutt supports connecting to external directory databases such as LDAP, ph/qi,
3188
3274
bbdb, or NIS through a wrapper script which connects to mutt using a simple
3220
3306
will activate the query menu. At the query menu, you can select one or more
3221
3307
addresses to be added to the prompt.
3222
3308
3223
6. Mailbox Formats
3309
6. Mailbox Formats
3224
3310
3225
3311
Mutt supports reading and writing of four different mailbox formats: mbox,
3226
3312
MMDF, MH and Maildir. The mailbox type is autodetected, so there is no need to
3252
3338
chosen in such a way they are unique, even when two programs are writing the
3253
3339
mailbox over NFS, which means that no file locking is needed.
3254
3340
3255
7. Mailbox Shortcuts
3341
7. Mailbox Shortcuts
3256
3342
3257
3343
There are a number of built in shortcuts which refer to specific mailboxes.
3258
3344
These shortcuts can be used anywhere you are prompted for a file or mailbox
3268
3354
3269
3355
● - or !! -- refers to the file you've last visited
3270
3356
3271
● ˜ -- refers to your home directory
3357
● ~ -- refers to your home directory
3272
3358
3273
3359
● = or + -- refers to your $folder directory
3274
3360
3275
3361
● @alias -- refers to the default save folder as determined by the address of
3276
3362
the alias
3277
3363
3278
8. Handling Mailing Lists
3364
8. Handling Mailing Lists
3279
3365
3280
3366
Mutt has a few configuration options that make dealing with large amounts of
3281
3367
mail easier. The first thing you must do is to let Mutt know what addresses you
3333
3419
list subject matter (or just to annotate messages individually). The
3334
3420
$index_format variable's ``%y'' and ``%Y'' escapes can be used to expand
3335
3421
``X-Label:'' fields in the index, and Mutt's pattern-matcher can match regular
3336
expressions to ``X-Label:'' fields with the ``˜y'' selector. ``X-Label:'' is
3422
expressions to ``X-Label:'' fields with the ``~y'' selector. ``X-Label:'' is
3337
3423
not a standard message header field, but it can easily be inserted by procmail
3338
3424
and other mail filtering agents.
3339
3425
3345
3431
because you can easily delete uninteresting threads and quickly find topics of
3346
3432
value.
3347
3433
3348
9. Editing threads
3434
9. Editing threads
3349
3435
3350
3436
Mutt has the ability to dynamically restructure threads that are broken either
3351
3437
by misconfigured software or bad behavior from some correspondents. This allows
3352
3438
to clean your mailboxes formats) from these annoyances which make it hard to
3353
3439
follow a discussion.
3354
3440
3355
9.1. Linking threads
3441
9.1. Linking threads
3356
3442
3357
3443
Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
3358
3444
"References:" headers when replying to a message. This results in broken
3364
3450
You can also connect multiple children at once, tagging them and using the
3365
3451
tag-prefix command (';') or the auto_tag option.
3366
3452
3367
9.2. Breaking threads
3453
9.2. Breaking threads
3368
3454
3369
3455
On mailing lists, some people are in the bad habit of starting a new discussion
3370
3456
by hitting "reply" to any message from the list and changing the subject to a
3372
3458
function (bound by default to #), which will turn the subthread starting from
3373
3459
the current message into a whole different thread.
3374
3460
3375
10. Delivery Status Notification (DSN) Support
3461
10. Delivery Status Notification (DSN) Support
3376
3462
3377
3463
RFC1894 defines a set of MIME content types for relaying information about the
3378
3464
status of electronic mail messages. These can be thought of as ``return
3379
receipts.'' Berkeley sendmail 8.8.x currently has some command line options in
3380
which the mail client can make requests as to what type of status messages
3381
should be returned.
3465
receipts.''
3382
3466
3383
To support this, there are two variables. $dsn_notify is used to request
3467
To support DSN, there are two variables. $dsn_notify is used to request
3384
3468
receipts for different results (such as failed message, message delivered,
3385
3469
etc.). $dsn_return requests how much of your message should be returned with
3386
the receipt (headers or full message). Refer to the man page on sendmail for
3387
more details on DSN.
3388
3389
11. Start a WWW Browser on URLs (EXTERNAL)
3470
the receipt (headers or full message).
3471
3472
When using $sendmail for mail delivery, you need to use either Berkeley
3473
sendmail 8.8.x (or greater) a MTA supporting DSN command line options
3474
compatible to Sendmail: The -N and -R options can be used by the mail client to
3475
make requests as to what type of status messages should be returned. Please
3476
consider your MTA documentation whether DSN is supported.
3477
3478
For SMTP delivery using $smtp_url, it depends on the capabilities announced by
3479
the server whether mutt will attempt to request DSN or not.
3480
3481
11. Start a WWW Browser on URLs (EXTERNAL)
3390
3482
3391
3483
If a message contains URLs (unified resource locator = address in the WWW space
3392
3484
like http://www.mutt.org/), it is efficient to get a menu with all the URLs and
3397
3489
macro index \cb |urlview\n
3398
3490
macro pager \cb |urlview\n
3399
3491
3400
Chapter 5. Mutt's MIME Support
3492
Chapter 5. Mutt's MIME Support
3401
3493
3402
3494
Table of Contents
3403
3495
3429
3521
file, which specifies the external commands to use for handling specific MIME
3430
3522
types.
3431
3523
3432
1. Using MIME in Mutt
3524
1. Using MIME in Mutt
3433
3525
3434
3526
There are three areas/menus in Mutt which deal with MIME, they are the pager
3435
3527
(while viewing a message), the attachment menu and the compose menu.
3436
3528
3437
1.1. Viewing MIME messages in the pager
3529
1.1. Viewing MIME messages in the pager
3438
3530
3439
3531
When you select a message from the index and view it in the pager, Mutt decodes
3440
3532
the message to a text representation. Mutt internally supports a number of MIME
3455
3547
3456
3548
[-- image/gif is unsupported (use 'v' to view this part) --]
3457
3549
3458
1.2. The Attachment Menu
3550
1.2. The Attachment Menu
3459
3551
3460
3552
The default binding for view-attachments is `v', which displays the attachment
3461
3553
menu for a message. The attachment menu displays a list of the attachments in a
3471
3563
3472
3564
See the help on the attachment menu for more information.
3473
3565
3474
1.3. The Compose Menu
3566
1.3. The Compose Menu
3475
3567
3476
3568
The compose menu is the menu you see before you send a message. It allows you
3477
3569
to edit the recipient list, the subject, and other aspects of your message. It
3497
3589
command (default: R). The final field is the description of the attachment, and
3498
3590
can be changed with the edit-description command (default: d).
3499
3591
3500
2. MIME Type configuration with mime.types
3592
2. MIME Type configuration with mime.types
3501
3593
3502
3594
When you add an attachment to your mail message, Mutt searches your personal
3503
3595
mime.types file at ${HOME}/.mime.types, and then the system mime.types file at
3528
3620
molecular viewers. Non-recognized mime types should only be used if the
3529
3621
recipient of the message is likely to be expecting such attachments.
3530
3622
3531
3. MIME Viewer configuration with mailcap
3623
3. MIME Viewer configuration with mailcap
3532
3624
3533
3625
Mutt supports RFC 1524 MIME Configuration, in particular the Unix specific
3534
3626
format specified in Appendix A of RFC 1524. This file format is commonly
3565
3657
In particular, the metamail distribution will install a mailcap file, usually
3566
3658
as /usr/local/etc/mailcap, which contains some baseline entries.
3567
3659
3568
3.1. The Basics of the mailcap file
3660
3.1. The Basics of the mailcap file
3569
3661
3570
3662
A mailcap file consists of a series of lines which are comments, blank, or
3571
3663
definitions.
3607
3699
text/html; lynx %s
3608
3700
3609
3701
In this case, lynx does not support viewing a file from stdin, so you must use
3610
the %s syntax. Note: Some older versions of lynx contain a bug where they will
3702
the %s syntax. Note:Some older versions of lynx contain a bug where they will
3611
3703
check the mailcap file for a viewer for text/html. They will find the line
3612
3704
which calls lynx, and run it. This causes lynx to continuously spawn itself to
3613
3705
view the object.
3625
3717
3626
3718
This is the simplest form of a mailcap file.
3627
3719
3628
3.2. Secure use of mailcap
3720
3.2. Secure use of mailcap
3629
3721
3630
3722
The interpretation of shell meta-characters embedded in MIME parameters can
3631
3723
lead to security problems in general. Mutt tries to quote parameters in
3652
3744
text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
3653
3745
&& test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
3654
3746
3655
3.3. Advanced mailcap Usage
3747
3.3. Advanced mailcap Usage
3656
3748
3657
3.3.1. Optional Fields
3749
3.3.1. Optional Fields
3658
3750
3659
3751
In addition to the required content-type and view command fields, you can add
3660
3752
semi-colon ';' separated fields to set flags and other options. Mutt recognizes
3724
3816
should be used. The command is defined with the command expansion rules
3725
3817
defined in the next section. If the command returns 0, then the test
3726
3818
passed, and Mutt uses this entry. If the command returns non-zero, then the
3727
test failed, and Mutt continues searching for the right entry. Note: the
3819
test failed, and Mutt continues searching for the right entry. Note:the
3728
3820
content-type must match before Mutt performs the test. For example:
3729
3821
3730
3822
text/html; netscape -remote 'openURL(%s)' ; test=RunningX
3736
3828
RunningX doesn't return 0, then Mutt will go on to the next entry and use
3737
3829
lynx to display the text/html object.
3738
3830
3739
3.3.2. Search Order
3831
3.3.2. Search Order
3740
3832
3741
3833
When searching for an entry in the mailcap file, Mutt will search for the most
3742
3834
useful entry for its purpose. For instance, if you are attempting to print an
3765
3857
if it should use the first entry. If the program returns non-zero, Mutt will
3766
3858
use the second entry for interactive viewing.
3767
3859
3768
3.3.3. Command Expansion
3860
3.3.3. Command Expansion
3769
3861
3770
3862
The various commands defined in the mailcap files are passed to the /bin/sh
3771
3863
shell using the system() function. Before the command is passed to /bin/sh -c,
3807
3899
The main purpose of these parameters is for multipart messages, which is
3808
3900
handled internally by Mutt.
3809
3901
3810
3.4. Example mailcap files
3902
3.4. Example mailcap files
3811
3903
3812
3904
This mailcap file is fairly simple and standard:
3813
3905
3856
3948
# Send excel spreadsheets to my NT box
3857
3949
application/ms-excel; open.pl %s
3858
3950
3859
4. MIME Autoview
3951
4. MIME Autoview
3860
3952
3861
3953
In addition to explicitly telling Mutt to view an attachment with the MIME
3862
3954
viewer defined in the mailcap file, Mutt has support for automatically viewing
3889
3981
This can be used with message-hook to autoview messages based on size, etc.
3890
3982
``unauto_view *'' will remove all previous entries.
3891
3983
3892
5. MIME Multipart/Alternative
3984
5. MIME Multipart/Alternative
3893
3985
3894
3986
Mutt has some heuristics for determining which attachment of a multipart/
3895
3987
alternative type to display. First, mutt will check the alternative_order list
3906
3998
To remove a MIME type from the alternative_order list, use the
3907
3999
unalternative_order command.
3908
4000
3909
6. Attachment Searching and Counting
4001
6. Attachment Searching and Counting
3910
4002
3911
4003
If you ever lose track of attachments in your mailboxes, Mutt's
3912
4004
attachment-counting and -searching support might be for you. You can make your
4001
4093
"attachments ?" will list your current settings in Muttrc format, so that it
4002
4094
can be pasted elsewhere.
4003
4095
4004
7. MIME Lookup
4096
7. MIME Lookup
4005
4097
4006
4098
Mutt's mime_lookup list specifies a list of mime-types that should not be
4007
4099
treated according to their mailcap entry. This option is designed to deal with
4017
4109
In addition, the unmime_lookup command may be used to disable this feature for
4018
4110
any particular mime-type if it had been set, for example, in a global muttrc.
4019
4111
4020
Chapter 6. Optional features
4112
Chapter 6. Optional features
4021
4113
4022
4114
Table of Contents
4023
4115
4039
4131
4040
4132
7.1. Header caching
4041
4133
7.2. Body caching
4042
4043
1. General notes
4044
4045
1.1. Enabling/disabling features
4134
7.3. Maintenance
4135
4136
1. General notes
4137
4138
1.1. Enabling/disabling features
4046
4139
4047
4140
Mutt supports several of optional features which can be enabled or disabled at
4048
4141
compile-time by giving the configure script certain arguments. These are listed
4055
4148
4056
4149
-USE_SSL_OPENSSL +USE_SSL_GNUTLS
4057
4150
4058
1.2. URL syntax
4151
1.2. URL syntax
4059
4152
4060
4153
Mutt optionally supports the IMAP, POP3 and SMTP protocols which require to
4061
4154
access servers using URLs. The canonical syntax for specifying URLs in mutt is
4082
4175
make mutt attempt to conect using SSL or TLS on a different port to encrypt the
4083
4176
communication.
4084
4177
4085
2. SSL/TLS Support
4178
2. SSL/TLS Support
4086
4179
4087
4180
If mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be
4088
4181
compiled with support for SSL or TLS using either OpenSSL or GnuTLS ( by
4091
4184
with remote servers if these protocols are suffixed with ``s'' for ``secure
4092
4185
communication''.
4093
4186
4094
3. POP3 Support
4187
3. POP3 Support
4095
4188
4096
4189
If Mutt was compiled with POP3 support (by running the configure script with
4097
4190
the --enable-pop flag), it has the ability to work with mailboxes located on a
4098
4191
remote POP3 server and fetch mail for local browsing.
4099
4192
4100
4193
Remote POP3 servers can be accessed using URLs with the pop protocol for
4101
unencrypted and pops for encrypted communication, see Section 1.2, “URL syntax”
4194
unencrypted and pops for encrypted communication, see Section 1.2, "URL syntax"
4102
4195
for details.
4103
4196
4104
4197
Polling for new mail is more expensive over POP3 than locally. For this reason
4113
4206
Note: If you only need to fetch all messages to a local mailbox you should
4114
4207
consider using a specialized program, such as fetchmail, getmail or similar.
4115
4208
4116
4. IMAP Support
4209
4. IMAP Support
4117
4210
4118
4211
If Mutt was compiled with IMAP support (by running the configure script with
4119
4212
the --enable-imap flag), it has the ability to work with folders located on a
4120
4213
remote IMAP server.
4121
4214
4122
You can access the remote inbox by selecting the folder by its URL (see
4123
Section 1.2, “URL syntax” for details) using the imap or imaps protocol.
4124
Alternatively, a pine-compatible notation is also supported, ie {[username@]
4125
imapserver[:port][/ssl]}path/to/folder
4215
You can access the remote inbox by selecting the folder by its URL (see Section
4216
1.2, "URL syntax" for details) using the imap or imaps protocol. Alternatively,
4217
a pine-compatible notation is also supported, ie {[username@]imapserver[:port]
4218
[/ssl]}path/to/folder
4126
4219
4127
4220
Note that not all servers use ``/'' as the hierarchy separator. Mutt should
4128
4221
correctly notice which separator is being used by the server and convert paths
4144
4237
v12.250, the server has been reported to disconnect a client if another client
4145
4238
selects the same folder.
4146
4239
4147
4.1. The Folder Browser
4240
4.1. The Folder Browser
4148
4241
4149
4242
As of version 1.2, mutt supports browsing mailboxes on an IMAP server. This is
4150
4243
mostly the same as the local file browser, with the following differences:
4164
4257
respectively). You may also subscribe and unsubscribe to mailboxes
4165
4258
(normally these are bound to s and u, respectively).
4166
4259
4167
4.2. Authentication
4260
4.2. Authentication
4168
4261
4169
4262
Mutt supports four authentication methods with IMAP servers: SASL, GSSAPI,
4170
4263
CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add NTLM
4198
4291
methods to try, in the order you wish to try them. If specified, this
4199
4292
overrides mutt's default (attempt everything, in the order listed above).
4200
4293
4201
5. SMTP Support
4294
5. SMTP Support
4202
4295
4203
4296
Besides supporting traditional mail delivery through a sendmail-compatible
4204
4297
program, mutt supports delivery through SMTP if it was configured and built
4208
4301
SMTP server to deliver messages; if it is unset, mutt will use the program
4209
4302
specified by $sendmail.
4210
4303
4211
For details on the URL syntax, please see Section 1.2, “URL syntax”.
4304
For details on the URL syntax, please see Section 1.2, "URL syntax".
4212
4305
4213
4306
The built-in SMTP support supports encryption (the smtps protocol using SSL or
4214
4307
TLS) as well as SMTP authentication using SASL. The authentication mechanisms
4215
4308
for SASL are specified in $smtp_authenticators defaulting to an empty list
4216
4309
which makes mutt try all available methods from most-secure to least-secure.
4217
4310
4218
6. Managing multiple accounts
4311
6. Managing multiple accounts
4219
4312
4220
4313
If you happen to have accounts on multiple IMAP, POP and/or SMTP servers, you
4221
4314
may find managing all the authentication settings inconvenient and error-prone.
4230
4323
account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
4231
4324
account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'
4232
4325
4233
7. Local caching
4326
7. Local caching
4234
4327
4235
4328
Mutt contains two types of local caching: (1) the so-called ``header caching''
4236
4329
and (2) the so-called ``body caching'' which are both described in this
4237
4330
section.
4238
4331
4239
These are optional which means they're not enabled by default. Details on how
4240
to enable either of these techniques are given in the following subsections.
4332
Header caching is optional as it depends on external libraries, body caching is
4333
always enabled if mutt is compiled with POP and/or IMAP support as these use it
4334
(body caching requires no external library).
4241
4335
4242
7.1. Header caching
4336
7.1. Header caching
4243
4337
4244
4338
Mutt provides optional support for caching message headers for the following
4245
4339
types of folders: IMAP, POP, Maildir and MH. Header caching greatly improves
4257
4351
(which may result in lower performance), but one file per folder if it points
4258
4352
to a directory.
4259
4353
4260
For the one-file-per-folder case, database files will be named by MD5 sums.
4261
They may be safely removed if a system is short on space. You can compute the
4262
name of the header cache file for a particular folder through a command like
4263
the following:
4354
For the one-file-per-folder case, database files for remote folders will be
4355
named according to their URL while database files for local folders will be
4356
named by the MD5 checksums of their path. These database files may be safely
4357
removed if a system is short on space. You can compute the name of the header
4358
cache file for a particular local folder through a command like the following:
4264
4359
4265
4360
$ printf '%s' '/path/to/folder' | md5sum
4266
$ printf '%s' 'imaps://user@host/path/to/folder' | md5sum
4267
$ printf '%s' 'pops://user@host' | md5sum
4268
4361
4269
4362
The md5sum command may also be named md5, depending on your operating system.
4270
4363
4271
7.2. Body caching
4364
7.2. Body caching
4365
4366
Both cache methods can be combined using the same directory for storage (and
4367
for IMAP/POP even provide meaningful file names) which simplifies manual
4368
maintenance tasks.
4272
4369
4273
4370
In addition to caching message headers only, mutt can also cache whole message
4274
4371
bodies. This results in faster display of messages for POP and IMAP folders
4275
4372
because messages usually have to be downloaded only once.
4276
4373
4277
If the configure script is called with --enable-pop and/or --enable-imap, body
4278
caching will be built in as it does not require additional software packages
4279
such as database libraries.
4280
4281
4374
For configuration, the variable $message_cachedir must point to a directory.
4282
4375
There, mutt will create a hierarchy of subdirectories named like:
4283
4376
proto:user@hostname where proto is either ``pop'' or ``imap.'' Within there for
4288
4381
All files can be removed as needed if the consumed disk space becomes an issue
4289
4382
as mutt will silently fetch missing items again.
4290
4383
4291
Chapter 7. Performance tuning
4384
7.3. Maintenance
4385
4386
Mutt does not (yet) support maintenance features for header cache database
4387
files so that files have to be removed in case they grow too big. It depends on
4388
the database library used for header caching whether disk space freed by
4389
removing messages is re-used.
4390
4391
For body caches, mutt can keep the local cache in sync with the remote mailbox
4392
if the $message_cache_clean variable is set. Cleaning means to remove messages
4393
from the cache which are no longer present in the mailbox which only happens
4394
when other mail clients or instances of mutt using a different body cache
4395
location delete messages (Mutt itself removes deleted messages from the cache
4396
when syncing a mailbox). As cleaning can take a noticeable amount of time, it
4397
should not be set in general but only occasionally.
4398
4399
Chapter 7. Performance tuning
4292
4400
4293
4401
Table of Contents
4294
4402
4296
4404
2. Reading messages from remote folders
4297
4405
3. Searching and limiting
4298
4406
4299
1. Reading and writing mailboxes
4407
1. Reading and writing mailboxes
4300
4408
4301
4409
Mutt's performance when reading mailboxes can be improved in two ways:
4302
4410
4322
4430
folder-hook ^pop 'set read_inc=1'
4323
4431
4324
4432
4325
2. Reading messages from remote folders
4433
These settings work on a per-message basis. However, as messages may greatly
4434
differ in size and certain operations are much faster than others, even
4435
per-folder settings of the increment variables may not be desirable as they
4436
produce either too few or too much progress updates. Thus, Mutt allows to limit
4437
the number of progress updates per second it'll actually send to the terminal
4438
using the $time_inc variable.
4439
4440
2. Reading messages from remote folders
4326
4441
4327
4442
Reading messages from remote folders such as IMAP an POP can be slow especially
4328
4443
for large mailboxes since mutt only caches a very limited number of recently
4332
4447
To improve performance and permanently cache whole messages, please refer to
4333
4448
mutt's so-called body caching for details.
4334
4449
4335
3. Searching and limiting
4450
3. Searching and limiting
4336
4451
4337
4452
When searching mailboxes either via a search or a limit action, for some
4338
4453
patterns mutt distinguishes between regular expression and string searches. For
4339
regular expressions, patterns are prefixed with ``˜'' and with ``='' for string
4454
regular expressions, patterns are prefixed with ``~'' and with ``='' for string
4340
4455
searches.
4341
4456
4342
4457
Even though a regular expression search is fast, it's several times slower than
4346
4461
4347
4462
For example, when limiting a large folder to all messages sent to or by an
4348
4463
author, it's much faster to search for the initial part of an e-mail address
4349
via =Luser@ instead of ˜Luser@. This is especially true for searching message
4464
via =Luser@ instead of ~Luser@. This is especially true for searching message
4350
4465
bodies since a larger amount of input has to be searched.
4351
4466
4352
4467
Please note that string search is an exact case-sensitive search while a
4353
4468
regular expression search with only lower-case letters performs a
4354
4469
case-insensitive search.
4355
4470
4356
Chapter 8. Reference
4471
Chapter 8. Reference
4357
4472
4358
4473
Table of Contents
4359
4474
4645
4760
3.282. thread_received
4646
4761
3.283. thorough_search
4647
4762
3.284. tilde
4648
3.285. timeout
4649
3.286. tmpdir
4650
3.287. to_chars
4651
3.288. tunnel
4652
3.289. use_8bitmime
4653
3.290. use_domain
4654
3.291. use_envelope_from
4655
3.292. use_from
4656
3.293. use_idn
4657
3.294. use_ipv6
4658
3.295. user_agent
4659
3.296. visual
4660
3.297. wait_key
4661
3.298. weed
4662
3.299. wrap
4663
3.300. wrap_search
4664
3.301. wrapmargin
4665
3.302. write_inc
4666
3.303. write_bcc
4763
3.285. time_inc
4764
3.286. timeout
4765
3.287. tmpdir
4766
3.288. to_chars
4767
3.289. tunnel
4768
3.290. use_8bitmime
4769
3.291. use_domain
4770
3.292. use_envelope_from
4771
3.293. use_from
4772
3.294. use_idn
4773
3.295. use_ipv6
4774
3.296. user_agent
4775
3.297. visual
4776
3.298. wait_key
4777
3.299. weed
4778
3.300. wrap
4779
3.301. wrap_search
4780
3.302. wrapmargin
4781
3.303. write_inc
4782
3.304. write_bcc
4667
4783
4668
4784
4. Functions
4669
4785
4681
4797
4.12. mix
4682
4798
4.13. editor
4683
4799
4684
1. Command line options
4800
1. Command line options
4685
4801
4686
4802
Running mutt with no arguments will make Mutt attempt to read your spool
4687
4803
mailbox. However, it is possible to read other mailboxes and to send messages
4688
4804
from the command line as well.
4689
4805
4690
Table 8.1. Command line options
4806
Table 8.1. Command line options
4691
4807
4692
4808
┌──────┬──────────────────────────────────────────────────────────────────────┐
4693
4809
│Option│ Description │
4750
4866
Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect
4751
4867
input from the file you wish to send. For example,
4752
4868
4753
mutt -s "data set for run #2" professor@bigschool.edu < ˜/run2.dat
4869
mutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat
4754
4870
4755
4871
This command will send a message to ``professor@bigschool.edu'' with a subject
4756
4872
of ``data set for run #2''. In the body of the message will be the contents of
4757
the file ``˜/run2.dat''.
4873
the file ``~/run2.dat''.
4758
4874
4759
4875
All files passed with -a file will be attached as a MIME part to the message.
4760
4876
To attach several files, use ``--'' to separate files and recipient addresses:
4761
4877
mutt -a *.png -- some@one.org
4762
4878
4763
2. Configuration Commands
4879
2. Configuration Commands
4764
4880
4765
4881
The following are the commands understood by mutt.
4766
4882
4767
● account-hook pattern command
4883
● account-hookpatterncommand
4768
4884
4769
● alias [ -group name [ ... ] ] key address [ , address, ... ]
4885
● alias [ -groupname [ ... ] ] keyaddress [ , address, ... ]
4770
4886
4771
4887
● unalias [ * | key ... ]
4772
4888
4773
● alternates [ -group name [ ... ] ] regexp [ regexp ... ]
4889
● alternates [ -groupname [ ... ] ] regexp [ regexp ... ]
4774
4890
4775
4891
● unalternates [ * | regexp ... ]
4776
4892
4777
● alternative-order mimetype [ mimetype ... ]
4778
4779
● unalternative-order mimetype [ mimetype ... ]
4780
4781
● auto_view mimetype [ mimetype ... ]
4782
4783
● unauto_view mimetype [ mimetype ... ]
4784
4785
● bind map key function
4786
4787
● charset-hook alias charset
4788
4789
● iconv-hook charset local-charset
4790
4791
● color object foreground background [ regexp ]
4792
4793
● uncolor index pattern [ pattern ... ]
4794
4795
● exec function [ function ... ]
4796
4797
● fcc-hook pattern mailbox
4798
4799
● fcc-save-hook pattern mailbox
4800
4801
● folder-hook pattern command
4802
4803
● hdr_order header [ header ... ]
4804
4805
● unhdr_order header [ header ... ]
4806
4807
● ignore pattern [ pattern ... ]
4808
4809
● unignore pattern [ pattern ... ]
4810
4811
● lists [ -group name [ ... ] ] regexp [ regexp ... ]
4812
4813
● unlists regexp [ regexp ... ]
4814
4815
● macro menu key sequence [ description ]
4816
4817
● mailboxes filename [ filename ... ]
4818
4819
● mbox-hook pattern mailbox
4820
4821
● message-hook pattern command
4822
4823
● mime_lookup mimetype [ mimetype ... ]
4824
4825
● unmime_lookup mimetype [ mimetype ... ]
4826
4827
● mono object attribute [ regexp ]
4828
4829
● unmono index pattern [ pattern ... ]
4830
4831
● my_hdr string
4832
4833
● unmy_hdr field [ field ... ]
4834
4835
● crypt-hook pattern key-id
4836
4837
● push string
4838
4839
● reset variable [variable ... ]
4840
4841
● save-hook regexp filename
4842
4843
● score pattern value
4844
4845
● unscore pattern [ pattern ... ]
4846
4847
● reply-hook pattern command
4848
4849
● send-hook pattern command
4850
4851
● send2-hook pattern command
4893
● alternative-ordermimetype [ mimetype ... ]
4894
4895
● unalternative-ordermimetype [ mimetype ... ]
4896
4897
● auto_viewmimetype [ mimetype ... ]
4898
4899
● unauto_viewmimetype [ mimetype ... ]
4900
4901
● bindmapkeyfunction
4902
4903
● charset-hookaliascharset
4904
4905
● iconv-hookcharsetlocal-charset
4906
4907
● colorobjectforegroundbackground [ regexp ]
4908
4909
● uncolorindexpattern [ pattern ... ]
4910
4911
● execfunction [ function ... ]
4912
4913
● fcc-hookpatternmailbox
4914
4915
● fcc-save-hookpatternmailbox
4916
4917
● folder-hookpatterncommand
4918
4919
● hdr_orderheader [ header ... ]
4920
4921
● unhdr_orderheader [ header ... ]
4922
4923
● ignorepattern [ pattern ... ]
4924
4925
● unignorepattern [ pattern ... ]
4926
4927
● lists [ -groupname [ ... ] ] regexp [ regexp ... ]
4928
4929
● unlistsregexp [ regexp ... ]
4930
4931
● macromenukeysequence [ description ]
4932
4933
● mailboxesfilename [ filename ... ]
4934
4935
● mbox-hookpatternmailbox
4936
4937
● message-hookpatterncommand
4938
4939
● mime_lookupmimetype [ mimetype ... ]
4940
4941
● unmime_lookupmimetype [ mimetype ... ]
4942
4943
● monoobject attribute [ regexp ]
4944
4945
● unmonoindexpattern [ pattern ... ]
4946
4947
● my_hdrstring
4948
4949
● unmy_hdrfield [ field ... ]
4950
4951
● crypt-hookpatternkey-id
4952
4953
● pushstring
4954
4955
● resetvariable [variable ... ]
4956
4957
● save-hookregexpfilename
4958
4959
● scorepatternvalue
4960
4961
● unscorepattern [ pattern ... ]
4962
4963
● reply-hookpatterncommand
4964
4965
● send-hookpatterncommand
4966
4967
● send2-hookpatterncommand
4852
4968
4853
4969
● set [no|inv]variable[=value] [ variable ... ]
4854
4970
4855
● unset variable [variable ... ]
4856
4857
● source filename
4858
4859
● spam pattern format
4860
4861
● nospam pattern
4862
4863
● subscribe [ -group name [ ... ] ] regexp [ regexp ... ]
4864
4865
● unsubscribe regexp [ regexp ... ]
4866
4867
● toggle variable [variable ... ]
4868
4869
● unhook hook-type
4870
4871
3. Configuration variables
4872
4873
3.1. abort_nosubject
4874
4875
Type: quadoption
4876
Default: ask-yes
4971
● unsetvariable [variable ... ]
4972
4973
● sourcefilename
4974
4975
● spampatternformat
4976
4977
● nospampattern
4978
4979
● subscribe [ -groupname [ ... ] ] regexp [ regexp ... ]
4980
4981
● unsubscriberegexp [ regexp ... ]
4982
4983
● togglevariable [variable ... ]
4984
4985
● unhookhook-type
4986
4987
3. Configuration variables
4988
4989
3.1. abort_nosubject
4990
4991
Type: quadoption
4992
Default: ask-yes
4877
4993
4878
4994
If set to yes, when composing messages and no subject is given at the subject
4879
4995
prompt, composition will be aborted. If set to no, composing messages with no
4880
4996
subject given at the subject prompt will never be aborted.
4881
4997
4882
3.2. abort_unmodified
4998
3.2. abort_unmodified
4883
4999
4884
Type: quadoption
4885
Default: yes
5000
Type: quadoption
5001
Default: yes
4886
5002
4887
5003
If set to yes, composition will automatically abort after editing the message
4888
5004
body if no changes are made to the file (this check only happens after the
4889
5005
first edit of the file). When set to no, composition will never be aborted.
4890
5006
4891
3.3. alias_file
5007
3.3. alias_file
4892
5008
4893
Type: path
4894
Default: "˜/.muttrc"
5009
Type: path
5010
Default: "~/.muttrc"
4895
5011
4896
5012
The default file in which to save aliases created by the ``create-alias''
4897
5013
function.
4899
5015
Note: Mutt will not automatically source this file; you must explicitly use the
4900
5016
``source'' command for it to be executed.
4901
5017
4902
The default for this option is the currently used muttrc file, or ``˜/.muttrc''
5018
The default for this option is the currently used muttrc file, or ``~/.muttrc''
4903
5019
if no user muttrc was found.
4904
5020
4905
3.4. alias_format
5021
3.4. alias_format
4906
5022
4907
Type: string
4908
Default: "%4n %2f %t %-10a %r"
5023
Type: string
5024
Default: "%4n %2f %t %-10a %r"
4909
5025
4910
5026
Specifies the format of the data displayed for the `alias' menu. The following
4911
5027
printf(3)-style sequences are available:
4930
5046
4931
5047
character which indicates if the alias is tagged for inclusion
4932
5048
4933
3.5. allow_8bit
5049
3.5. allow_8bit
4934
5050
4935
Type: boolean
4936
Default: yes
5051
Type: boolean
5052
Default: yes
4937
5053
4938
5054
Controls whether 8-bit data is converted to 7-bit using either Quoted-
4939
5055
Printable or Base64 encoding when sending mail.
4940
5056
4941
3.6. allow_ansi
5057
3.6. allow_ansi
4942
5058
4943
Type: boolean
4944
Default: no
5059
Type: boolean
5060
Default: no
4945
5061
4946
5062
Controls whether ANSI color codes in messages (and color tags in rich text
4947
5063
messages) are to be interpreted. Messages containing these codes are rare, but
4950
5066
message could include a line like "[-- PGP output follows ..." and give it the
4951
5067
same color as your attachment color.
4952
5068
4953
3.7. arrow_cursor
5069
3.7. arrow_cursor
4954
5070
4955
Type: boolean
4956
Default: no
5071
Type: boolean
5072
Default: no
4957
5073
4958
5074
When set, an arrow (``->'') will be used to indicate the current entry in menus
4959
5075
instead of highlighting the whole line. On slow network or modem links this
4960
5076
will make response faster because there is less that has to be redrawn on the
4961
5077
screen when moving to the next or previous entries in the menu.
4962
5078
4963
3.8. ascii_chars
5079
3.8. ascii_chars
4964
5080
4965
Type: boolean
4966
Default: no
5081
Type: boolean
5082
Default: no
4967
5083
4968
5084
If set, Mutt will use plain ASCII characters when displaying thread and
4969
5085
attachment trees, instead of the default ACS characters.
4970
5086
4971
3.9. askbcc
5087
3.9. askbcc
4972
5088
4973
Type: boolean
4974
Default: no
5089
Type: boolean
5090
Default: no
4975
5091
4976
5092
If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients before
4977
5093
editing an outgoing message.
4978
5094
4979
3.10. askcc
5095
3.10. askcc
4980
5096
4981
Type: boolean
4982
Default: no
5097
Type: boolean
5098
Default: no
4983
5099
4984
5100
If set, Mutt will prompt you for carbon-copy (Cc) recipients before editing the
4985
5101
body of an outgoing message.
4986
5102
4987
3.11. assumed_charset
5103
3.11. assumed_charset
4988
5104
4989
Type: string
4990
Default: ""
5105
Type: string
5106
Default: ""
4991
5107
4992
5108
This variable is a colon-separated list of character encoding schemes for
4993
5109
messages without character encoding indication. Header field values and message
5001
5117
5002
5118
However, only the first content is valid for the message body.
5003
5119
5004
3.12. attach_charset
5120
3.12. attach_charset
5005
5121
5006
Type: string
5007
Default: ""
5122
Type: string
5123
Default: ""
5008
5124
5009
5125
This variable is a colon-separated list of character encoding schemes for text
5010
5126
file attachments. If unset, $charset value will be used instead. For example,
5015
5131
Note: "iso-2022-*" must be put at the head of the value as shown above if
5016
5132
included.
5017
5133
5018
3.13. attach_format
5134
3.13. attach_format
5019
5135
5020
Type: string
5021
Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
5136
Type: string
5137
Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
5022
5138
5023
5139
This variable describes the format of the `attachment' menu. The following
5024
5140
printf-style sequences are understood:
5102
5218
5103
5219
For an explanation of `soft-fill', see the ``$index_format'' documentation.
5104
5220
5105
3.14. attach_sep
5221
3.14. attach_sep
5106
5222
5107
Type: string
5108
Default: "\n"
5223
Type: string
5224
Default: "\n"
5109
5225
5110
5226
The separator to add between attachments when operating (saving, printing,
5111
5227
piping, etc) on a list of tagged attachments.
5112
5228
5113
3.15. attach_split
5229
3.15. attach_split
5114
5230
5115
Type: boolean
5116
Default: yes
5231
Type: boolean
5232
Default: yes
5117
5233
5118
5234
If this variable is unset, when operating (saving, printing, piping, etc) on a
5119
5235
list of tagged attachments, Mutt will concatenate the attachments and will
5121
5237
after each attachment. When set, Mutt will operate on the attachments one by
5122
5238
one.
5123
5239
5124
3.16. attribution
5240
3.16. attribution
5125
5241
5126
Type: string
5127
Default: "On %d, %n wrote:"
5242
Type: string
5243
Default: "On %d, %n wrote:"
5128
5244
5129
5245
This is the string that will precede a message which has been included in a
5130
5246
reply. For a full listing of defined printf()-like sequences see the section on
5131
5247
``$index_format''.
5132
5248
5133
3.17. autoedit
5249
3.17. autoedit
5134
5250
5135
Type: boolean
5136
Default: no
5251
Type: boolean
5252
Default: no
5137
5253
5138
5254
When set along with ``$edit_headers'', Mutt will skip the initial send-menu and
5139
5255
allow you to immediately begin editing the body of your message. The send-menu
5141
5257
5142
5258
Also see ``$fast_reply''.
5143
5259
5144
3.18. auto_tag
5260
3.18. auto_tag
5145
5261
5146
Type: boolean
5147
Default: no
5262
Type: boolean
5263
Default: no
5148
5264
5149
5265
When set, functions in the index menu which affect a message will be applied to
5150
5266
all tagged messages (if there are any). When unset, you must first use the
5151
5267
tag-prefix function (default: ";") to make the next function apply to all
5152
5268
tagged messages.
5153
5269
5154
3.19. beep
5270
3.19. beep
5155
5271
5156
Type: boolean
5157
Default: yes
5272
Type: boolean
5273
Default: yes
5158
5274
5159
5275
When this variable is set, mutt will beep when an error occurs.
5160
5276
5161
3.20. beep_new
5277
3.20. beep_new
5162
5278
5163
Type: boolean
5164
Default: no
5279
Type: boolean
5280
Default: no
5165
5281
5166
5282
When this variable is set, mutt will beep whenever it prints a message
5167
5283
notifying you of new mail. This is independent of the setting of the ``$beep''
5168
5284
variable.
5169
5285
5170
3.21. bounce
5286
3.21. bounce
5171
5287
5172
Type: quadoption
5173
Default: ask-yes
5288
Type: quadoption
5289
Default: ask-yes
5174
5290
5175
5291
Controls whether you will be asked to confirm bouncing messages. If set to yes
5176
5292
you don't get asked if you want to bounce a message. Setting this variable to
5177
5293
no is not generally useful, and thus not recommended, because you are unable to
5178
5294
bounce messages.
5179
5295
5180
3.22. bounce_delivered
5296
3.22. bounce_delivered
5181
5297
5182
Type: boolean
5183
Default: yes
5298
Type: boolean
5299
Default: yes
5184
5300
5185
5301
When this variable is set, mutt will include Delivered-To headers when bouncing
5186
5302
messages. Postfix users may wish to unset this variable.
5187
5303
5188
3.23. braille_friendly
5304
3.23. braille_friendly
5189
5305
5190
Type: boolean
5191
Default: no
5306
Type: boolean
5307
Default: no
5192
5308
5193
5309
When this variable is set, mutt will place the cursor at the beginning of the
5194
5310
current line in menus, even when the arrow_cursor variable is unset, making it
5196
5312
option is disabled by default because many visual terminals don't permit making
5197
5313
the cursor invisible.
5198
5314
5199
3.24. check_mbox_size
5315
3.24. check_mbox_size
5200
5316
5201
Type: boolean
5202
Default: no
5317
Type: boolean
5318
Default: no
5203
5319
5204
5320
When this variable is set, mutt will use file size attribute instead of access
5205
5321
time when checking for new mail.
5206
5322
5207
3.25. charset
5323
3.25. charset
5208
5324
5209
Type: string
5210
Default: ""
5325
Type: string
5326
Default: ""
5211
5327
5212
5328
Character set your terminal uses to display and enter textual data. It is also
5213
5329
the fallback for $send_charset.
5214
5330
5215
3.26. check_new
5331
3.26. check_new
5216
5332
5217
Type: boolean
5218
Default: yes
5333
Type: boolean
5334
Default: yes
5219
5335
5220
5336
Note: this option only affects maildir and MH style mailboxes.
5221
5337
5225
5341
been looked at. If check_new is unset, no check for new mail is performed while
5226
5342
the mailbox is open.
5227
5343
5228
3.27. collapse_unread
5344
3.27. collapse_unread
5229
5345
5230
Type: boolean
5231
Default: yes
5346
Type: boolean
5347
Default: yes
5232
5348
5233
5349
When unset, Mutt will not collapse a thread if it contains any unread messages.
5234
5350
5235
3.28. uncollapse_jump
5351
3.28. uncollapse_jump
5236
5352
5237
Type: boolean
5238
Default: no
5353
Type: boolean
5354
Default: no
5239
5355
5240
5356
When set, Mutt will jump to the next unread message, if any, when the current
5241
5357
thread is uncollapsed.
5242
5358
5243
3.29. compose_format
5359
3.29. compose_format
5244
5360
5245
Type: string
5246
Default: "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-"
5361
Type: string
5362
Default: "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-"
5247
5363
5248
5364
Controls the format of the status line displayed in the Compose menu. This
5249
5365
string is similar to ``$status_format'', but has its own set of printf()-like
5268
5384
See the text describing the ``$status_format'' option for more information on
5269
5385
how to set ``$compose_format''.
5270
5386
5271
3.30. config_charset
5387
3.30. config_charset
5272
5388
5273
Type: string
5274
Default: ""
5389
Type: string
5390
Default: ""
5275
5391
5276
5392
When defined, Mutt will recode commands in rc files from this encoding.
5277
5393
5278
3.31. confirmappend
5394
3.31. confirmappend
5279
5395
5280
Type: boolean
5281
Default: yes
5396
Type: boolean
5397
Default: yes
5282
5398
5283
5399
When set, Mutt will prompt for confirmation when appending messages to an
5284
5400
existing mailbox.
5285
5401
5286
3.32. confirmcreate
5402
3.32. confirmcreate
5287
5403
5288
Type: boolean
5289
Default: yes
5404
Type: boolean
5405
Default: yes
5290
5406
5291
5407
When set, Mutt will prompt for confirmation when saving messages to a mailbox
5292
5408
which does not yet exist before creating it.
5293
5409
5294
3.33. connect_timeout
5410
3.33. connect_timeout
5295
5411
5296
Type: number
5297
Default: 30
5412
Type: number
5413
Default: 30
5298
5414
5299
5415
Causes Mutt to timeout a network connection (for IMAP or POP) after this many
5300
5416
seconds if the connection is not able to be established. A negative value
5301
5417
causes Mutt to wait indefinitely for the connection to succeed.
5302
5418
5303
3.34. content_type
5419
3.34. content_type
5304
5420
5305
Type: string
5306
Default: "text/plain"
5421
Type: string
5422
Default: "text/plain"
5307
5423
5308
5424
Sets the default Content-Type for the body of newly composed messages.
5309
5425
5310
3.35. copy
5426
3.35. copy
5311
5427
5312
Type: quadoption
5313
Default: yes
5428
Type: quadoption
5429
Default: yes
5314
5430
5315
5431
This variable controls whether or not copies of your outgoing messages will be
5316
5432
saved for later references. Also see ``$record'', ``$save_name'', ``$force_name
5317
5433
'' and ``fcc-hook''.
5318
5434
5319
3.36. crypt_use_gpgme
5435
3.36. crypt_use_gpgme
5320
5436
5321
Type: boolean
5322
Default: no
5437
Type: boolean
5438
Default: no
5323
5439
5324
5440
This variable controls the use of the GPGME-enabled crypto backends. If it is
5325
5441
set and Mutt was built with gpgme support, the gpgme code for S/MIME and PGP
5326
5442
will be used instead of the classic code. Note that you need to set this option
5327
5443
in .muttrc; it won't have any effect when used interactively.
5328
5444
5329
3.37. crypt_use_pka
5445
3.37. crypt_use_pka
5330
5446
5331
Type: boolean
5332
Default: no
5447
Type: boolean
5448
Default: no
5333
5449
5334
5450
(http://www.g10code.de/docs/pka-intro.de.pdf) during signature verification
5335
5451
(only supported by the GPGME backend).
5336
5452
5337
3.38. crypt_autopgp
5453
3.38. crypt_autopgp
5338
5454
5339
Type: boolean
5340
Default: yes
5455
Type: boolean
5456
Default: yes
5341
5457
5342
5458
This variable controls whether or not mutt may automatically enable PGP
5343
5459
encryption/signing for messages. See also ``$crypt_autoencrypt'', ``
5344
5460
$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``
5345
5461
$smime_is_default''.
5346
5462
5347
3.39. crypt_autosmime
5463
3.39. crypt_autosmime
5348
5464
5349
Type: boolean
5350
Default: yes
5465
Type: boolean
5466
Default: yes
5351
5467
5352
5468
This variable controls whether or not mutt may automatically enable S/MIME
5353
5469
encryption/signing for messages. See also ``$crypt_autoencrypt'', ``
5354
5470
$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``
5355
5471
$smime_is_default''.
5356
5472
5357
3.40. date_format
5473
3.40. date_format
5358
5474
5359
Type: string
5360
Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"
5475
Type: string
5476
Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"
5361
5477
5362
5478
This variable controls the format of the date printed by the ``%d'' sequence in
5363
5479
``$index_format''. This is passed to the strftime call to process the date. See
5369
5485
discarded, and the month and week day names in the rest of the string are
5370
5486
expanded in the C locale (that is in US English).
5371
5487
5372
3.41. default_hook
5488
3.41. default_hook
5373
5489
5374
Type: string
5375
Default: "˜f %s !˜P | (˜P ˜C %s)"
5490
Type: string
5491
Default: "~f %s !~P | (~P ~C %s)"
5376
5492
5377
5493
This variable controls how message-hooks, reply-hooks, send-hooks, send2-hooks,
5378
5494
save-hooks, and fcc-hooks will be interpreted if they are specified with only a
5383
5499
is from you (if the from address matches ``alternates'') and is to or cc'ed to
5384
5500
a user matching the given regular expression.
5385
5501
5386
3.42. delete
5502
3.42. delete
5387
5503
5388
Type: quadoption
5389
Default: ask-yes
5504
Type: quadoption
5505
Default: ask-yes
5390
5506
5391
5507
Controls whether or not messages are really deleted when closing or
5392
5508
synchronizing a mailbox. If set to yes, messages marked for deleting will
5393
5509
automatically be purged without prompting. If set to no, messages marked for
5394
5510
deletion will be kept in the mailbox.
5395
5511
5396
3.43. delete_untag
5512
3.43. delete_untag
5397
5513
5398
Type: boolean
5399
Default: yes
5514
Type: boolean
5515
Default: yes
5400
5516
5401
5517
If this option is set, mutt will untag messages when marking them for deletion.
5402
5518
This applies when you either explicitly delete a message, or when you save it
5403
5519
to another folder.
5404
5520
5405
3.44. digest_collapse
5521
3.44. digest_collapse
5406
5522
5407
Type: boolean
5408
Default: yes
5523
Type: boolean
5524
Default: yes
5409
5525
5410
5526
If this option is set, mutt's received-attachments menu will not show the
5411
5527
subparts of individual messages in a multipart/digest. To see these subparts,
5412
5528
press 'v' on that menu.
5413
5529
5414
3.45. display_filter
5530
3.45. display_filter
5415
5531
5416
Type: path
5417
Default: ""
5532
Type: path
5533
Default: ""
5418
5534
5419
5535
When set, specifies a command used to filter messages. When a message is viewed
5420
5536
it is passed as standard input to $display_filter, and the filtered message is
5421
5537
read from the standard output.
5422
5538
5423
3.46. dotlock_program
5539
3.46. dotlock_program
5424
5540
5425
Type: path
5426
Default: "/usr/local/bin/mutt_dotlock"
5541
Type: path
5542
Default: "/usr/local/bin/mutt_dotlock"
5427
5543
5428
5544
Contains the path of the mutt_dotlock (8) binary to be used by mutt.
5429
5545
5430
3.47. dsn_notify
5431
5432
Type: string
5433
Default: ""
5434
5435
Note: you should not enable this unless you are using Sendmail 8.8.x or
5436
greater.
5546
3.47. dsn_notify
5547
5548
Type: string
5549
Default: ""
5437
5550
5438
5551
This variable sets the request for when notification is returned. The string
5439
5552
consists of a comma separated list (no spaces!) of one or more of the
5443
5556
5444
5557
Example: set dsn_notify="failure,delay"
5445
5558
5446
3.48. dsn_return
5447
5448
Type: string
5449
Default: ""
5450
5451
Note: you should not enable this unless you are using Sendmail 8.8.x or
5452
greater.
5559
Note: when using $sendmail for delivery, you should not enable this unless you
5560
are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
5561
-compatible interface supporting the -N option for DSN. For SMTP delivery, it
5562
depends on the server whether DSN is supported or not.
5563
5564
3.48. dsn_return
5565
5566
Type: string
5567
Default: ""
5453
5568
5454
5569
This variable controls how much of your message is returned in DSN messages. It
5455
5570
may be set to either hdrs to return just the message header, or full to return
5457
5572
5458
5573
Example: set dsn_return=hdrs
5459
5574
5460
3.49. duplicate_threads
5461
5462
Type: boolean
5463
Default: yes
5575
Note: when using $sendmail for delivery, you should not enable this unless you
5576
are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
5577
-compatible interface supporting the -R option for DSN. For SMTP delivery, it
5578
depends on the server whether DSN is supported or not.
5579
5580
3.49. duplicate_threads
5581
5582
Type: boolean
5583
Default: yes
5464
5584
5465
5585
This variable controls whether mutt, when sorting by threads, threads messages
5466
5586
with the same message-id together. If it is set, it will indicate that it
5467
5587
thinks they are duplicates of each other with an equals sign in the thread
5468
5588
diagram.
5469
5589
5470
3.50. edit_headers
5590
3.50. edit_headers
5471
5591
5472
Type: boolean
5473
Default: no
5592
Type: boolean
5593
Default: no
5474
5594
5475
5595
This option allows you to edit the header of your outgoing messages along with
5476
5596
the body of your message.
5477
5597
5478
3.51. editor
5598
3.51. editor
5479
5599
5480
Type: path
5481
Default: ""
5600
Type: path
5601
Default: ""
5482
5602
5483
5603
This variable specifies which editor is used by mutt. It defaults to the value
5484
5604
of the VISUAL, or EDITOR, environment variable, or to the string "vi" if
5485
5605
neither of those are set.
5486
5606
5487
3.52. encode_from
5607
3.52. encode_from
5488
5608
5489
Type: boolean
5490
Default: no
5609
Type: boolean
5610
Default: no
5491
5611
5492
5612
When set, mutt will quoted-printable encode messages when they contain the
5493
5613
string "From " in the beginning of a line. Useful to avoid the tampering
5494
5614
certain mail delivery and transport agents tend to do with messages.
5495
5615
5496
3.53. envelope_from_address
5616
3.53. envelope_from_address
5497
5617
5498
Type: e-mail address
5499
Default: ""
5618
Type: e-mail address
5619
Default: ""
5500
5620
5501
5621
Manually sets the envelope sender for outgoing messages. This value is ignored
5502
5622
if ``$use_envelope_from'' is unset.
5503
5623
5504
3.54. escape
5624
3.54. escape
5505
5625
5506
Type: string
5507
Default: "˜"
5626
Type: string
5627
Default: "~"
5508
5628
5509
5629
Escape character to use for functions in the builtin editor.
5510
5630
5511
3.55. fast_reply
5631
3.55. fast_reply
5512
5632
5513
Type: boolean
5514
Default: no
5633
Type: boolean
5634
Default: no
5515
5635
5516
5636
When set, the initial prompt for recipients and subject are skipped when
5517
5637
replying to messages, and the initial prompt for subject is skipped when
5519
5639
5520
5640
Note: this variable has no effect when the ``$autoedit'' variable is set.
5521
5641
5522
3.56. fcc_attach
5642
3.56. fcc_attach
5523
5643
5524
Type: boolean
5525
Default: yes
5644
Type: boolean
5645
Default: yes
5526
5646
5527
5647
This variable controls whether or not attachments on outgoing messages are
5528
5648
saved along with the main body of your message.
5529
5649
5530
3.57. fcc_clear
5650
3.57. fcc_clear
5531
5651
5532
Type: boolean
5533
Default: no
5652
Type: boolean
5653
Default: no
5534
5654
5535
5655
When this variable is set, FCCs will be stored unencrypted and unsigned, even
5536
5656
when the actual message is encrypted and/or signed. (PGP only)
5537
5657
5538
3.58. folder
5658
3.58. folder
5539
5659
5540
Type: path
5541
Default: "˜/Mail"
5660
Type: path
5661
Default: "~/Mail"
5542
5662
5543
5663
Specifies the default location of your mailboxes. A `+' or `=' at the beginning
5544
5664
of a pathname will be expanded to the value of this variable. Note that if you
5546
5666
assignment occurs before you use `+' or `=' for any other variables since
5547
5667
expansion takes place during the `set' command.
5548
5668
5549
3.59. folder_format
5669
3.59. folder_format
5550
5670
5551
Type: string
5552
Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"
5671
Type: string
5672
Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"
5553
5673
5554
5674
This variable allows you to customize the file browser display to your personal
5555
5675
taste. This string is similar to ``$index_format'', but has its own set of
5609
5729
5610
5730
For an explanation of `soft-fill', see the ``$index_format'' documentation.
5611
5731
5612
3.60. followup_to
5732
3.60. followup_to
5613
5733
5614
Type: boolean
5615
Default: yes
5734
Type: boolean
5735
Default: yes
5616
5736
5617
5737
Controls whether or not the Mail-Followup-To header field is generated when
5618
5738
sending mail. When set, Mutt will generate this field when you are replying to
5627
5747
message sent to a subscribed list will be sent to both the list and your
5628
5748
address, resulting in two copies of the same email for you.
5629
5749
5630
3.61. force_name
5750
3.61. force_name
5631
5751
5632
Type: boolean
5633
Default: no
5752
Type: boolean
5753
Default: no
5634
5754
5635
5755
This variable is similar to ``$save_name'', except that Mutt will store a copy
5636
5756
of your outgoing message by the username of the address you are sending to even
5638
5758
5639
5759
Also see the ``$record'' variable.
5640
5760
5641
3.62. forward_decode
5761
3.62. forward_decode
5642
5762
5643
Type: boolean
5644
Default: yes
5763
Type: boolean
5764
Default: yes
5645
5765
5646
5766
Controls the decoding of complex MIME messages into text/plain when forwarding
5647
5767
a message. The message header is also RFC2047 decoded. This variable is only
5648
5768
used, if ``$mime_forward'' is unset, otherwise ``$mime_forward_decode'' is used
5649
5769
instead.
5650
5770
5651
3.63. forward_edit
5771
3.63. forward_edit
5652
5772
5653
Type: quadoption
5654
Default: yes
5773
Type: quadoption
5774
Default: yes
5655
5775
5656
5776
This quadoption controls whether or not the user is automatically placed in the
5657
5777
editor when forwarding messages. For those who always want to forward with no
5658
5778
modification, use a setting of ``no''.
5659
5779
5660
3.64. forward_format
5780
3.64. forward_format
5661
5781
5662
Type: string
5663
Default: "[%a: %s]"
5782
Type: string
5783
Default: "[%a: %s]"
5664
5784
5665
5785
This variable controls the default subject when forwarding a message. It uses
5666
5786
the same format sequences as the ``$index_format'' variable.
5667
5787
5668
3.65. forward_quote
5788
3.65. forward_quote
5669
5789
5670
Type: boolean
5671
Default: no
5790
Type: boolean
5791
Default: no
5672
5792
5673
5793
When set forwarded messages included in the main body of the message (when ``
5674
5794
$mime_forward'' is unset) will be quoted using ``$indent_string''.
5675
5795
5676
3.66. from
5796
3.66. from
5677
5797
5678
Type: e-mail address
5679
Default: ""
5798
Type: e-mail address
5799
Default: ""
5680
5800
5681
5801
When set, this variable contains a default from address. It can be overridden
5682
5802
using my_hdr (including from send-hooks) and ``$reverse_name''. This variable
5684
5804
5685
5805
Defaults to the contents of the environment variable EMAIL.
5686
5806
5687
3.67. gecos_mask
5807
3.67. gecos_mask
5688
5808
5689
Type: regular expression
5690
Default: "^[^,]*"
5809
Type: regular expression
5810
Default: "^[^,]*"
5691
5811
5692
5812
A regular expression used by mutt to parse the GECOS field of a password entry
5693
5813
when expanding the alias. By default the regular expression is set to "^[^,]*"
5701
5821
expression that will match the whole name so mutt will expand "Franklin" to
5702
5822
"Franklin, Steve".
5703
5823
5704
3.68. hdrs
5824
3.68. hdrs
5705
5825
5706
Type: boolean
5707
Default: yes
5826
Type: boolean
5827
Default: yes
5708
5828
5709
5829
When unset, the header fields normally added by the ``my_hdr'' command are not
5710
5830
created. This variable must be unset before composing a new message or replying
5711
5831
in order to take effect. If set, the user defined header fields are added to
5712
5832
every new message.
5713
5833
5714
3.69. header
5834
3.69. header
5715
5835
5716
Type: boolean
5717
Default: no
5836
Type: boolean
5837
Default: no
5718
5838
5719
5839
When set, this variable causes Mutt to include the header of the message you
5720
5840
are replying to into the edit buffer. The ``$weed'' setting applies.
5721
5841
5722
3.70. help
5842
3.70. help
5723
5843
5724
Type: boolean
5725
Default: yes
5844
Type: boolean
5845
Default: yes
5726
5846
5727
5847
When set, help lines describing the bindings for the major functions provided
5728
5848
by each menu are displayed on the first line of the screen.
5732
5852
if a binding is changed while Mutt is running. Since this variable is primarily
5733
5853
aimed at new users, neither of these should present a major problem.
5734
5854
5735
3.71. hidden_host
5855
3.71. hidden_host
5736
5856
5737
Type: boolean
5738
Default: no
5857
Type: boolean
5858
Default: no
5739
5859
5740
5860
When set, mutt will skip the host name part of ``$hostname'' variable when
5741
5861
adding the domain part to addresses. This variable does not affect the
5742
5862
generation of Message-IDs, and it will not lead to the cut-off of first-level
5743
5863
domains.
5744
5864
5745
3.72. hide_limited
5865
3.72. hide_limited
5746
5866
5747
Type: boolean
5748
Default: no
5867
Type: boolean
5868
Default: no
5749
5869
5750
5870
When set, mutt will not show the presence of messages that are hidden by
5751
5871
limiting, in the thread tree.
5752
5872
5753
3.73. hide_missing
5873
3.73. hide_missing
5754
5874
5755
Type: boolean
5756
Default: yes
5875
Type: boolean
5876
Default: yes
5757
5877
5758
5878
When set, mutt will not show the presence of missing messages in the thread
5759
5879
tree.
5760
5880
5761
3.74. hide_thread_subject
5881
3.74. hide_thread_subject
5762
5882
5763
Type: boolean
5764
Default: yes
5883
Type: boolean
5884
Default: yes
5765
5885
5766
5886
When set, mutt will not show the subject of messages in the thread tree that
5767
5887
have the same subject as their parent or closest previously displayed sibling.
5768
5888
5769
3.75. hide_top_limited
5889
3.75. hide_top_limited
5770
5890
5771
Type: boolean
5772
Default: no
5891
Type: boolean
5892
Default: no
5773
5893
5774
5894
When set, mutt will not show the presence of messages that are hidden by
5775
5895
limiting, at the top of threads in the thread tree. Note that when
5776
5896
$hide_limited is set, this option will have no effect.
5777
5897
5778
3.76. hide_top_missing
5898
3.76. hide_top_missing
5779
5899
5780
Type: boolean
5781
Default: yes
5900
Type: boolean
5901
Default: yes
5782
5902
5783
5903
When set, mutt will not show the presence of missing messages at the top of
5784
5904
threads in the thread tree. Note that when $hide_missing is set, this option
5785
5905
will have no effect.
5786
5906
5787
3.77. history
5907
3.77. history
5788
5908
5789
Type: number
5790
Default: 10
5909
Type: number
5910
Default: 10
5791
5911
5792
5912
This variable controls the size (in number of strings remembered) of the string
5793
5913
history buffer. The buffer is cleared each time the variable is set.
5794
5914
5795
3.78. history_file
5915
3.78. history_file
5796
5916
5797
Type: path
5798
Default: "˜/.mutthistory"
5917
Type: path
5918
Default: "~/.mutthistory"
5799
5919
5800
5920
The file in which Mutt will save its history.
5801
5921
5802
3.79. honor_followup_to
5922
3.79. honor_followup_to
5803
5923
5804
Type: quadoption
5805
Default: yes
5924
Type: quadoption
5925
Default: yes
5806
5926
5807
5927
This variable controls whether or not a Mail-Followup-To header is honored when
5808
5928
group-replying to a message.
5809
5929
5810
3.80. hostname
5811
5812
Type: string
5813
Default: ""
5814
5815
Specifies the hostname to use after the ``@'' in local e-mail addresses. This
5816
overrides the compile time definition obtained from /etc/resolv.conf.
5817
5818
3.81. ignore_linear_white_space
5819
5820
Type: boolean
5821
Default: no
5930
3.80. hostname
5931
5932
Type: string
5933
Default: ""
5934
5935
Specifies the fully-qualified hostname of the system mutt is running on
5936
containing the host's name and the DNS domain it belongs to. It is used as the
5937
domain part (after ``@'') for local email addresses as well as Message-Id
5938
headers.
5939
5940
Its value is determined at startup as follows: If the node's name as returned
5941
by the uname(3) function contains the hostname and the domain, these are used
5942
to construct $hostname. If there is no domain part returned, Mutt will look for
5943
a ``domain'' or ``search'' line in /etc/resolv.conf to determine the domain.
5944
Optionally, Mutt can be compiled with a fixed domain name in which case a
5945
detected one is not used.
5946
5947
Also see ``$use_domain'' and ``$hidden_host''.
5948
5949
3.81. ignore_linear_white_space
5950
5951
Type: boolean
5952
Default: no
5822
5953
5823
5954
This option replaces linear-white-space between encoded-word and *text to a
5824
5955
single space to prevent the display of MIME-encoded ``Subject'' field from
5825
5956
being divided into multiple lines.
5826
5957
5827
3.82. ignore_list_reply_to
5958
3.82. ignore_list_reply_to
5828
5959
5829
Type: boolean
5830
Default: no
5960
Type: boolean
5961
Default: no
5831
5962
5832
5963
Affects the behaviour of the reply function when replying to messages from
5833
mailing lists. When set, if the ``Reply-To:'' field is set to the same value as
5834
the ``To:'' field, Mutt assumes that the ``Reply-To:'' field was set by the
5835
mailing list to automate responses to the list, and will ignore this field. To
5836
direct a response to the mailing list when this option is set, use the
5837
list-reply function; group-reply will reply to both the sender and the list.
5838
5839
3.83. imap_authenticators
5840
5841
Type: string
5842
Default: ""
5964
mailing lists (as defined by the ``subscribe'' or ``lists'' commands). When
5965
set, if the ``Reply-To:'' field is set to the same value as the ``To:'' field,
5966
Mutt assumes that the ``Reply-To:'' field was set by the mailing list to
5967
automate responses to the list, and will ignore this field. To direct a
5968
response to the mailing list when this option is set, use the list-reply
5969
function; group-reply will reply to both the sender and the list.
5970
5971
3.83. imap_authenticators
5972
5973
Type: string
5974
Default: ""
5843
5975
5844
5976
This is a colon-delimited list of authentication methods mutt may attempt to
5845
5977
use to log in to an IMAP server, in the order mutt should try them.
5854
5986
methods are unavailable. If a method is available but authentication fails,
5855
5987
mutt will not connect to the IMAP server.
5856
5988
5857
3.84. imap_check_subscribed
5989
3.84. imap_check_subscribed
5858
5990
5859
Type: boolean
5860
Default: no
5991
Type: boolean
5992
Default: no
5861
5993
5862
5994
When set, mutt will fetch the set of subscribed folders from your server on
5863
5995
connection, and add them to the set of mailboxes it polls for new mail. See
5864
5996
also the ``mailboxes'' command.
5865
5997
5866
3.85. imap_delim_chars
5998
3.85. imap_delim_chars
5867
5999
5868
Type: string
5869
Default: "/."
6000
Type: string
6001
Default: "/."
5870
6002
5871
6003
This contains the list of characters which you would like to treat as folder
5872
6004
separators for displaying IMAP paths. In particular it helps in using the '='
5873
6005
shortcut for your folder variable.
5874
6006
5875
3.86. imap_headers
6007
3.86. imap_headers
5876
6008
5877
Type: string
5878
Default: ""
6009
Type: string
6010
Default: ""
5879
6011
5880
6012
Mutt requests these header fields in addition to the default headers ("DATE
5881
6013
FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE CONTENT-DESCRIPTION
5883
6015
index menu. You may want to add more headers for spam detection. Note: This is
5884
6016
a space separated list.
5885
6017
5886
3.87. imap_idle
6018
3.87. imap_idle
5887
6019
5888
Type: boolean
5889
Default: no
6020
Type: boolean
6021
Default: no
5890
6022
5891
6023
When set, mutt will attempt to use the IMAP IDLE extension to check for new
5892
6024
mail in the current mailbox. Some servers (dovecot was the inspiration for this
5893
6025
option) react badly to mutt's implementation. If your connection seems to
5894
6026
freeze up periodically, try unsetting this.
5895
6027
5896
3.88. imap_keepalive
6028
3.88. imap_keepalive
5897
6029
5898
Type: number
5899
Default: 900
6030
Type: number
6031
Default: 900
5900
6032
5901
6033
This variable specifies the maximum amount of time in seconds that mutt will
5902
6034
wait before polling open IMAP connections, to prevent the server from closing
5906
6038
this number if you find yourself getting disconnected from your IMAP server due
5907
6039
to inactivity.
5908
6040
5909
3.89. imap_list_subscribed
6041
3.89. imap_list_subscribed
5910
6042
5911
Type: boolean
5912
Default: no
6043
Type: boolean
6044
Default: no
5913
6045
5914
6046
This variable configures whether IMAP folder browsing will look for only
5915
6047
subscribed folders or all folders. This can be toggled in the IMAP browser with
5916
6048
the toggle-subscribed function.
5917
6049
5918
3.90. imap_login
6050
3.90. imap_login
5919
6051
5920
Type: string
5921
Default: ""
6052
Type: string
6053
Default: ""
5922
6054
5923
6055
Your login name on the IMAP server.
5924
6056
5925
6057
This variable defaults to the value of imap_user.
5926
6058
5927
3.91. imap_pass
6059
3.91. imap_pass
5928
6060
5929
Type: string
5930
Default: ""
6061
Type: string
6062
Default: ""
5931
6063
5932
6064
Specifies the password for your IMAP account. If unset, Mutt will prompt you
5933
6065
for your password when you invoke the fetch-mail function. Warning: you should
5935
6067
superuser can read your muttrc even if you are the only one who can read the
5936
6068
file.
5937
6069
5938
3.92. imap_passive
6070
3.92. imap_passive
5939
6071
5940
Type: boolean
5941
Default: yes
6072
Type: boolean
6073
Default: yes
5942
6074
5943
6075
When set, mutt will not open new IMAP connections to check for new mail. Mutt
5944
6076
will only check for new mail over existing IMAP connections. This is useful if
5945
6077
you don't want to be prompted to user/password pairs on mutt invocation, or if
5946
6078
opening the connection is slow.
5947
6079
5948
3.93. imap_peek
6080
3.93. imap_peek
5949
6081
5950
Type: boolean
5951
Default: yes
6082
Type: boolean
6083
Default: yes
5952
6084
5953
6085
When set, mutt will avoid implicitly marking your mail as read whenever you
5954
6086
fetch a message from the server. This is generally a good thing, but can make
5955
6087
closing an IMAP folder somewhat slower. This option exists to appease speed
5956
6088
freaks.
5957
6089
5958
3.94. imap_servernoise
6090
3.94. imap_servernoise
5959
6091
5960
Type: boolean
5961
Default: yes
6092
Type: boolean
6093
Default: yes
5962
6094
5963
6095
When set, mutt will display warning messages from the IMAP server as error
5964
6096
messages. Since these messages are often harmless, or generated due to
5965
6097
configuration problems on the server which are out of the users' hands, you may
5966
6098
wish to suppress them at some point.
5967
6099
5968
3.95. imap_user
6100
3.95. imap_user
5969
6101
5970
Type: string
5971
Default: ""
6102
Type: string
6103
Default: ""
5972
6104
5973
6105
The name of the user whose mail you intend to access on the IMAP server.
5974
6106
5975
6107
This variable defaults to your user name on the local machine.
5976
6108
5977
3.96. implicit_autoview
6109
3.96. implicit_autoview
5978
6110
5979
Type: boolean
5980
Default: no
6111
Type: boolean
6112
Default: no
5981
6113
5982
6114
If set to ``yes'', mutt will look for a mailcap entry with the copiousoutput
5983
6115
flag set for every MIME attachment it doesn't have an internal viewer defined
5984
6116
for. If such an entry is found, mutt will use the viewer defined in that entry
5985
6117
to convert the body part to text form.
5986
6118
5987
3.97. include
6119
3.97. include
5988
6120
5989
Type: quadoption
5990
Default: ask-yes
6121
Type: quadoption
6122
Default: ask-yes
5991
6123
5992
6124
Controls whether or not a copy of the message(s) you are replying to is
5993
6125
included in your reply.
5994
6126
5995
3.98. include_onlyfirst
6127
3.98. include_onlyfirst
5996
6128
5997
Type: boolean
5998
Default: no
6129
Type: boolean
6130
Default: no
5999
6131
6000
6132
Controls whether or not Mutt includes only the first attachment of the message
6001
6133
you are replying.
6002
6134
6003
3.99. indent_string
6135
3.99. indent_string
6004
6136
6005
Type: string
6006
Default: "> "
6137
Type: string
6138
Default: "> "
6007
6139
6008
6140
Specifies the string to prepend to each line of text quoted in a message to
6009
6141
which you are replying. You are strongly encouraged not to change this value,
6012
6144
This option is a format string, please see the description of ``$index_format''
6013
6145
for supported printf()-style sequences.
6014
6146
6015
3.100. index_format
6147
3.100. index_format
6016
6148
6017
Type: string
6018
Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
6149
Type: string
6150
Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
6019
6151
6020
6152
This variable allows you to customize the message index display to your
6021
6153
personal taste.
6068
6200
6069
6201
%f
6070
6202
6071
entire From: line (address + real name)
6203
sender (address + real name), either From: or Return-Path:
6072
6204
6073
6205
%F
6074
6206
6203
6335
there's still room. If necessary, soft-fill will eat text leftwards to make
6204
6336
room for rightward text.
6205
6337
6338
Note that these expandos are supported in ``save-hook'', ``fcc-hook'' and ``
6339
fcc-save-hook'', too.
6340
6206
6341
See also: ``$to_chars''.
6207
6342
6208
3.101. ispell
6343
3.101. ispell
6209
6344
6210
Type: path
6211
Default: "ispell"
6345
Type: path
6346
Default: "ispell"
6212
6347
6213
6348
How to invoke ispell (GNU's spell-checking software).
6214
6349
6215
3.102. keep_flagged
6350
3.102. keep_flagged
6216
6351
6217
Type: boolean
6218
Default: no
6352
Type: boolean
6353
Default: no
6219
6354
6220
6355
If set, read messages marked as flagged will not be moved from your spool
6221
6356
mailbox to your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
6222
6357
6223
3.103. locale
6358
3.103. locale
6224
6359
6225
Type: string
6226
Default: "C"
6360
Type: string
6361
Default: "C"
6227
6362
6228
6363
The locale used by strftime(3) to format dates. Legal values are the strings
6229
6364
your system accepts for the locale variable LC_TIME.
6230
6365
6231
3.104. mail_check
6366
3.104. mail_check
6232
6367
6233
Type: number
6234
Default: 5
6368
Type: number
6369
Default: 5
6235
6370
6236
6371
This variable configures how often (in seconds) mutt should look for new mail.
6237
6372
6238
3.105. mailcap_path
6373
3.105. mailcap_path
6239
6374
6240
Type: string
6241
Default: ""
6375
Type: string
6376
Default: ""
6242
6377
6243
6378
This variable specifies which files to consult when attempting to display MIME
6244
6379
bodies not directly supported by Mutt.
6245
6380
6246
3.106. mailcap_sanitize
6381
3.106. mailcap_sanitize
6247
6382
6248
Type: boolean
6249
Default: yes
6383
Type: boolean
6384
Default: yes
6250
6385
6251
6386
If set, mutt will restrict possible characters in mailcap % expandos to a
6252
6387
well-defined set of safe characters. This is the safe setting, but we are not
6254
6389
6255
6390
DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING!
6256
6391
6257
3.107. header_cache
6392
3.107. header_cache
6258
6393
6259
Type: path
6260
Default: ""
6394
Type: path
6395
Default: ""
6261
6396
6262
6397
The header_cache variable points to the header cache database. If header_cache
6263
6398
points to a directory it will contain a header cache database per folder. If
6264
6399
header_cache points to a file that file will be a single global header cache.
6265
6400
By default it is unset so no header caching will be used.
6266
6401
6267
3.108. maildir_header_cache_verify
6402
3.108. maildir_header_cache_verify
6268
6403
6269
Type: boolean
6270
Default: yes
6404
Type: boolean
6405
Default: yes
6271
6406
6272
6407
Check for Maildir unaware programs other than mutt having modified maildir
6273
6408
files when the header cache is in use. This incurs one stat(2) per message
6274
6409
every time the folder is opened.
6275
6410
6276
3.109. header_cache_pagesize
6411
3.109. header_cache_pagesize
6277
6412
6278
Type: string
6279
Default: "16384"
6413
Type: string
6414
Default: "16384"
6280
6415
6281
6416
When mutt is compiled with either gdbm or bdb4 as the header cache backend,
6282
6417
this option changes the database page size. Too large or too small values can
6283
6418
waste space, memory, or CPU time. The default should be more or less optimal
6284
6419
for most use cases.
6285
6420
6286
3.110. header_cache_compress
6421
3.110. header_cache_compress
6287
6422
6288
Type: boolean
6289
Default: yes
6423
Type: boolean
6424
Default: yes
6290
6425
6291
6426
When mutt is compiled with qdbm as header cache backend, this option determines
6292
6427
whether the database will be compressed. Compression results in database files
6293
6428
roughly being one fifth of the usual diskspace, but the uncompression can
6294
6429
result in a slower opening of cached folder(s).
6295
6430
6296
3.111. maildir_trash
6431
3.111. maildir_trash
6297
6432
6298
Type: boolean
6299
Default: no
6433
Type: boolean
6434
Default: no
6300
6435
6301
6436
If set, messages marked as deleted will be saved with the maildir (T)rashed
6302
6437
flag instead of unlinked. NOTE: this only applies to maildir-style mailboxes.
6303
6438
Setting it will have no effect on other mailbox types.
6304
6439
6305
3.112. mark_old
6306
6307
Type: boolean
6308
Default: yes
6309
6310
Controls whether or not mutt marks new unread messages as old if you exit a
6440
3.112. mark_old
6441
6442
Type: boolean
6443
Default: yes
6444
6445
Controls whether or not mutt marks newunread messages as old if you exit a
6311
6446
mailbox without reading them. With this option set, the next time you start
6312
6447
mutt, the messages will show up with an "O" next to them in the index menu,
6313
6448
indicating that they are old.
6314
6449
6315
3.113. markers
6450
3.113. markers
6316
6451
6317
Type: boolean
6318
Default: yes
6452
Type: boolean
6453
Default: yes
6319
6454
6320
6455
Controls the display of wrapped lines in the internal pager. If set, a ``+''
6321
6456
marker is displayed at the beginning of wrapped lines. Also see the ``
6322
6457
$smart_wrap'' variable.
6323
6458
6324
3.114. mask
6459
3.114. mask
6325
6460
6326
Type: regular expression
6327
Default: "!^\.[^.]"
6461
Type: regular expression
6462
Default: "!^\.[^.]"
6328
6463
6329
6464
A regular expression used in the file browser, optionally preceded by the not
6330
6465
operator ``!''. Only files whose names match this mask will be shown. The match
6331
6466
is always case-sensitive.
6332
6467
6333
3.115. mbox
6468
3.115. mbox
6334
6469
6335
Type: path
6336
Default: "˜/mbox"
6470
Type: path
6471
Default: "~/mbox"
6337
6472
6338
6473
This specifies the folder into which read mail in your ``$spoolfile'' folder
6339
6474
will be appended.
6340
6475
6341
3.116. mbox_type
6476
3.116. mbox_type
6342
6477
6343
Type: folder magic
6344
Default: mbox
6478
Type: folder magic
6479
Default: mbox
6345
6480
6346
6481
The default mailbox type used when creating new folders. May be any of mbox,
6347
6482
MMDF, MH and Maildir.
6348
6483
6349
3.117. metoo
6484
3.117. metoo
6350
6485
6351
Type: boolean
6352
Default: no
6486
Type: boolean
6487
Default: no
6353
6488
6354
6489
If unset, Mutt will remove your address (see the ``alternates'' command) from
6355
6490
the list of recipients when replying to a message.
6356
6491
6357
3.118. menu_context
6492
3.118. menu_context
6358
6493
6359
Type: number
6360
Default: 0
6494
Type: number
6495
Default: 0
6361
6496
6362
6497
This variable controls the number of lines of context that are given when
6363
6498
scrolling through menus. (Similar to ``$pager_context''.)
6364
6499
6365
3.119. menu_move_off
6500
3.119. menu_move_off
6366
6501
6367
Type: boolean
6368
Default: yes
6502
Type: boolean
6503
Default: yes
6369
6504
6370
6505
When unset, the bottom entry of menus will never scroll up past the bottom of
6371
6506
the screen, unless there are less entries than lines. When set, the bottom
6372
6507
entry may move off the bottom.
6373
6508
6374
3.120. menu_scroll
6509
3.120. menu_scroll
6375
6510
6376
Type: boolean
6377
Default: no
6511
Type: boolean
6512
Default: no
6378
6513
6379
6514
When set, menus will be scrolled up or down one line when you attempt to move
6380
6515
across a screen boundary. If unset, the screen is cleared and the next or
6381
6516
previous page of the menu is displayed (useful for slow links to avoid many
6382
6517
redraws).
6383
6518
6384
3.121. meta_key
6519
3.121. meta_key
6385
6520
6386
Type: boolean
6387
Default: no
6521
Type: boolean
6522
Default: no
6388
6523
6389
6524
If set, forces Mutt to interpret keystrokes with the high bit (bit 8) set as if
6390
6525
the user had pressed the ESC key and whatever key remains after having the high
6393
6528
result of removing the high bit from ``0xf8'' is ``0x78'', which is the ASCII
6394
6529
character ``x''.
6395
6530
6396
3.122. mh_purge
6531
3.122. mh_purge
6397
6532
6398
Type: boolean
6399
Default: no
6533
Type: boolean
6534
Default: no
6400
6535
6401
6536
When unset, mutt will mimic mh's behaviour and rename deleted messages to ,<old
6402
6537
file name> in mh folders instead of really deleting them. If the variable is
6403
6538
set, the message files will simply be deleted.
6404
6539
6405
3.123. mh_seq_flagged
6540
3.123. mh_seq_flagged
6406
6541
6407
Type: string
6408
Default: "flagged"
6542
Type: string
6543
Default: "flagged"
6409
6544
6410
6545
The name of the MH sequence used for flagged messages.
6411
6546
6412
3.124. mh_seq_replied
6547
3.124. mh_seq_replied
6413
6548
6414
Type: string
6415
Default: "replied"
6549
Type: string
6550
Default: "replied"
6416
6551
6417
6552
The name of the MH sequence used to tag replied messages.
6418
6553
6419
3.125. mh_seq_unseen
6554
3.125. mh_seq_unseen
6420
6555
6421
Type: string
6422
Default: "unseen"
6556
Type: string
6557
Default: "unseen"
6423
6558
6424
6559
The name of the MH sequence used for unseen messages.
6425
6560
6426
3.126. mime_forward
6561
3.126. mime_forward
6427
6562
6428
Type: quadoption
6429
Default: no
6563
Type: quadoption
6564
Default: no
6430
6565
6431
6566
When set, the message you are forwarding will be attached as a separate MIME
6432
6567
part instead of included in the main body of the message. This is useful for
6436
6571
6437
6572
Also see ``$forward_decode'' and ``$mime_forward_decode''.
6438
6573
6439
3.127. mime_forward_decode
6574
3.127. mime_forward_decode
6440
6575
6441
Type: boolean
6442
Default: no
6576
Type: boolean
6577
Default: no
6443
6578
6444
6579
Controls the decoding of complex MIME messages into text/plain when forwarding
6445
6580
a message while ``$mime_forward'' is set. Otherwise ``$forward_decode'' is used
6446
6581
instead.
6447
6582
6448
3.128. mime_forward_rest
6583
3.128. mime_forward_rest
6449
6584
6450
Type: quadoption
6451
Default: yes
6585
Type: quadoption
6586
Default: yes
6452
6587
6453
6588
When forwarding multiple attachments of a MIME message from the recvattach
6454
6589
menu, attachments which cannot be decoded in a reasonable manner will be
6455
6590
attached to the newly composed message if this option is set.
6456
6591
6457
3.129. mix_entry_format
6592
3.129. mix_entry_format
6458
6593
6459
Type: string
6460
Default: "%4n %c %-16s %a"
6594
Type: string
6595
Default: "%4n %c %-16s %a"
6461
6596
6462
6597
This variable describes the format of a remailer line on the mixmaster chain
6463
6598
selection screen. The following printf-like sequences are supported:
6478
6613
6479
6614
The remailer's e-mail address.
6480
6615
6481
3.130. mixmaster
6616
3.130. mixmaster
6482
6617
6483
Type: path
6484
Default: "mixmaster"
6618
Type: path
6619
Default: "mixmaster"
6485
6620
6486
6621
This variable contains the path to the Mixmaster binary on your system. It is
6487
6622
used with various sets of parameters to gather the list of known remailers, and
6488
6623
to finally send a message through the mixmaster chain.
6489
6624
6490
3.131. move
6625
3.131. move
6491
6626
6492
Type: quadoption
6493
Default: ask-no
6627
Type: quadoption
6628
Default: ask-no
6494
6629
6495
6630
Controls whether or not Mutt will move read messages from your spool mailbox to
6496
6631
your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
6497
6632
6498
3.132. message_cachedir
6633
3.132. message_cachedir
6499
6634
6500
Type: path
6501
Default: ""
6635
Type: path
6636
Default: ""
6502
6637
6503
6638
Set this to a directory and mutt will cache copies of messages from your IMAP
6504
6639
and POP servers here. You are free to remove entries at any time, for instance
6505
6640
if stale entries accumulate because you have deleted messages with another mail
6506
6641
client.
6507
6642
6508
3.133. message_cache_clean
6643
3.133. message_cache_clean
6509
6644
6510
Type: boolean
6511
Default: no
6645
Type: boolean
6646
Default: no
6512
6647
6513
6648
If set, mutt will clean out obsolete entries from the cache when the mailbox is
6514
6649
synchronized. You probably only want to set it every once in a while, since it
6515
6650
can be a little slow.
6516
6651
6517
3.134. message_format
6652
3.134. message_format
6518
6653
6519
Type: string
6520
Default: "%s"
6654
Type: string
6655
Default: "%s"
6521
6656
6522
6657
This is the string displayed in the ``attachment'' menu for attachments of type
6523
6658
message/rfc822. For a full listing of defined printf()-like sequences see the
6524
6659
section on ``$index_format''.
6525
6660
6526
3.135. narrow_tree
6661
3.135. narrow_tree
6527
6662
6528
Type: boolean
6529
Default: no
6663
Type: boolean
6664
Default: no
6530
6665
6531
6666
This variable, when set, makes the thread tree narrower, allowing deeper
6532
6667
threads to fit on the screen.
6533
6668
6534
3.136. net_inc
6669
3.136. net_inc
6535
6670
6536
Type: number
6537
Default: 10
6671
Type: number
6672
Default: 10
6538
6673
6539
6674
Operations that expect to transfer a large amount of data over the network will
6540
6675
update their progress every net_inc kilobytes. If set to 0, no progress
6542
6677
6543
6678
See also ``$read_inc'' and ``$write_inc''.
6544
6679
6545
3.137. pager
6680
3.137. pager
6546
6681
6547
Type: path
6548
Default: "builtin"
6682
Type: path
6683
Default: "builtin"
6549
6684
6550
6685
This variable specifies which pager you would like to use to view messages.
6551
6686
builtin means to use the builtin pager, otherwise this variable should specify
6556
6691
screen resizes cause lines longer than the screen width to be badly formatted
6557
6692
in the help menu.
6558
6693
6559
3.138. pager_context
6694
3.138. pager_context
6560
6695
6561
Type: number
6562
Default: 0
6696
Type: number
6697
Default: 0
6563
6698
6564
6699
This variable controls the number of lines of context that are given when
6565
6700
displaying the next or previous page in the internal pager. By default, Mutt
6566
6701
will display the line after the last one on the screen at the top of the next
6567
6702
page (0 lines of context).
6568
6703
6569
3.139. pager_format
6704
3.139. pager_format
6570
6705
6571
Type: string
6572
Default: "-%Z- %C/%m: %-20.20n %s%* -- (%P)"
6706
Type: string
6707
Default: "-%Z- %C/%m: %-20.20n %s%* -- (%P)"
6573
6708
6574
6709
This variable controls the format of the one-line message ``status'' displayed
6575
6710
before each message in either the internal or an external pager. The valid
6576
6711
sequences are listed in the ``$index_format'' section.
6577
6712
6578
3.140. pager_index_lines
6713
3.140. pager_index_lines
6579
6714
6580
Type: number
6581
Default: 0
6715
Type: number
6716
Default: 0
6582
6717
6583
6718
Determines the number of lines of a mini-index which is shown when in the
6584
6719
pager. The current message, unless near the top or bottom of the folder, will
6591
6726
folder is less than pager_index_lines, then the index will only use as many
6592
6727
lines as it needs.
6593
6728
6594
3.141. pager_stop
6729
3.141. pager_stop
6595
6730
6596
Type: boolean
6597
Default: no
6731
Type: boolean
6732
Default: no
6598
6733
6599
6734
When set, the internal-pager will not move to the next message when you are at
6600
6735
the end of a message and invoke the next-page function.
6601
6736
6602
3.142. crypt_autosign
6737
3.142. crypt_autosign
6603
6738
6604
Type: boolean
6605
Default: no
6739
Type: boolean
6740
Default: no
6606
6741
6607
6742
Setting this variable will cause Mutt to always attempt to cryptographically
6608
6743
sign outgoing messages. This can be overridden by use of the pgp-menu, when
6610
6745
$smime_is_default'' is set, then OpenSSL is used instead to create S/MIME
6611
6746
messages and settings can be overridden by use of the smime-menu. (Crypto only)
6612
6747
6613
3.143. crypt_autoencrypt
6748
3.143. crypt_autoencrypt
6614
6749
6615
Type: boolean
6616
Default: no
6750
Type: boolean
6751
Default: no
6617
6752
6618
6753
Setting this variable will cause Mutt to always attempt to PGP encrypt outgoing
6619
6754
messages. This is probably only useful in connection to the send-hook command.
6622
6757
used instead to create S/MIME messages and settings can be overridden by use of
6623
6758
the smime-menu. (Crypto only)
6624
6759
6625
3.144. pgp_ignore_subkeys
6760
3.144. pgp_ignore_subkeys
6626
6761
6627
Type: boolean
6628
Default: yes
6762
Type: boolean
6763
Default: yes
6629
6764
6630
6765
Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, the
6631
6766
principal key will inherit the subkeys' capabilities. Unset this if you want to
6632
6767
play interesting key selection games. (PGP only)
6633
6768
6634
3.145. crypt_replyencrypt
6769
3.145. crypt_replyencrypt
6635
6770
6636
Type: boolean
6637
Default: yes
6771
Type: boolean
6772
Default: yes
6638
6773
6639
6774
If set, automatically PGP or OpenSSL encrypt replies to messages which are
6640
6775
encrypted. (Crypto only)
6641
6776
6642
3.146. crypt_replysign
6777
3.146. crypt_replysign
6643
6778
6644
Type: boolean
6645
Default: no
6779
Type: boolean
6780
Default: no
6646
6781
6647
6782
If set, automatically PGP or OpenSSL sign replies to messages which are signed.
6648
6783
6649
6784
Note: this does not work on messages that are encrypted and signed! (Crypto
6650
6785
only)
6651
6786
6652
3.147. crypt_replysignencrypted
6787
3.147. crypt_replysignencrypted
6653
6788
6654
Type: boolean
6655
Default: no
6789
Type: boolean
6790
Default: no
6656
6791
6657
6792
If set, automatically PGP or OpenSSL sign replies to messages which are
6658
6793
encrypted. This makes sense in combination with ``$crypt_replyencrypt'',
6660
6795
This works around the problem noted in ``$crypt_replysign'', that mutt is not
6661
6796
able to find out whether an encrypted message is also signed. (Crypto only)
6662
6797
6663
3.148. crypt_timestamp
6798
3.148. crypt_timestamp
6664
6799
6665
Type: boolean
6666
Default: yes
6800
Type: boolean
6801
Default: yes
6667
6802
6668
6803
If set, mutt will include a time stamp in the lines surrounding PGP or S/MIME
6669
6804
output, so spoofing such lines is more difficult. If you are using colors to
6670
6805
mark these lines, and rely on these, you may unset this setting. (Crypto only)
6671
6806
6672
3.149. pgp_use_gpg_agent
6807
3.149. pgp_use_gpg_agent
6673
6808
6674
Type: boolean
6675
Default: no
6809
Type: boolean
6810
Default: no
6676
6811
6677
6812
If set, mutt will use a possibly-running gpg-agent process. (PGP only)
6678
6813
6679
3.150. crypt_verify_sig
6814
3.150. crypt_verify_sig
6680
6815
6681
Type: quadoption
6682
Default: yes
6816
Type: quadoption
6817
Default: yes
6683
6818
6684
6819
If ``yes'', always attempt to verify PGP or S/MIME signatures. If ``ask'', ask
6685
6820
whether or not to verify the signature. If ``no'', never attempt to verify
6686
6821
cryptographic signatures. (Crypto only)
6687
6822
6688
3.151. smime_is_default
6823
3.151. smime_is_default
6689
6824
6690
Type: boolean
6691
Default: no
6825
Type: boolean
6826
Default: no
6692
6827
6693
6828
The default behaviour of mutt is to use PGP on all auto-sign/encryption
6694
6829
operations. To override and to use OpenSSL instead this must be set. However,
6696
6831
same application that was used to sign/encrypt the original message. (Note that
6697
6832
this variable can be overridden by unsetting $crypt_autosmime.) (S/MIME only)
6698
6833
6699
3.152. smime_ask_cert_label
6834
3.152. smime_ask_cert_label
6700
6835
6701
Type: boolean
6702
Default: yes
6836
Type: boolean
6837
Default: yes
6703
6838
6704
6839
This flag controls whether you want to be asked to enter a label for a
6705
6840
certificate about to be added to the database or not. It is set by default. (S/
6706
6841
MIME only)
6707
6842
6708
3.153. smime_decrypt_use_default_key
6843
3.153. smime_decrypt_use_default_key
6709
6844
6710
Type: boolean
6711
Default: yes
6845
Type: boolean
6846
Default: yes
6712
6847
6713
6848
If set (default) this tells mutt to use the default key for decryption.
6714
6849
Otherwise, if manage multiple certificate-key-pairs, mutt will try to use the
6715
6850
mailbox-address to determine the key to use. It will ask you to supply a key,
6716
6851
if it can't find one. (S/MIME only)
6717
6852
6718
3.154. pgp_entry_format
6853
3.154. pgp_entry_format
6719
6854
6720
Type: string
6721
Default: "%4n %t%f %4l/0x%k %-4a %2c %u"
6855
Type: string
6856
Default: "%4n %t%f %4l/0x%k %-4a %2c %u"
6722
6857
6723
6858
This variable allows you to customize the PGP key selection menu to your
6724
6859
personal taste. This string is similar to ``$index_format'', but has its own
6762
6897
6763
6898
(PGP only)
6764
6899
6765
3.155. pgp_good_sign
6900
3.155. pgp_good_sign
6766
6901
6767
Type: regular expression
6768
Default: ""
6902
Type: regular expression
6903
Default: ""
6769
6904
6770
6905
If you assign a text to this variable, then a PGP signature is only considered
6771
6906
verified if the output from $pgp_verify_command contains the text. Use this
6772
6907
variable if the exit code from the command is 0 even for bad signatures. (PGP
6773
6908
only)
6774
6909
6775
3.156. pgp_check_exit
6910
3.156. pgp_check_exit
6776
6911
6777
Type: boolean
6778
Default: yes
6912
Type: boolean
6913
Default: yes
6779
6914
6780
6915
If set, mutt will check the exit code of the PGP subprocess when signing or
6781
6916
encrypting. A non-zero exit code means that the subprocess failed. (PGP only)
6782
6917
6783
3.157. pgp_long_ids
6918
3.157. pgp_long_ids
6784
6919
6785
Type: boolean
6786
Default: no
6920
Type: boolean
6921
Default: no
6787
6922
6788
6923
If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs. (PGP
6789
6924
only)
6790
6925
6791
3.158. pgp_retainable_sigs
6926
3.158. pgp_retainable_sigs
6792
6927
6793
Type: boolean
6794
Default: no
6928
Type: boolean
6929
Default: no
6795
6930
6796
6931
If set, signed and encrypted messages will consist of nested multipart/signed
6797
6932
and multipart/encrypted body parts.
6800
6935
the outer layer (multipart/encrypted) can be easily removed, while the inner
6801
6936
multipart/signed part is retained. (PGP only)
6802
6937
6803
3.159. pgp_autoinline
6938
3.159. pgp_autoinline
6804
6939
6805
Type: boolean
6806
Default: no
6940
Type: boolean
6941
Default: no
6807
6942
6808
6943
This option controls whether Mutt generates old-style inline (traditional) PGP
6809
6944
encrypted or signed messages under certain circumstances. This can be
6814
6949
MIME messages when inline (traditional) would not work. See also: ``
6815
6950
$pgp_mime_auto''.
6816
6951
6817
Also note that using the old-style PGP message format is strongly deprecated.
6952
Also note that using the old-style PGP message format is stronglydeprecated.
6818
6953
(PGP only)
6819
6954
6820
3.160. pgp_replyinline
6955
3.160. pgp_replyinline
6821
6956
6822
Type: boolean
6823
Default: no
6957
Type: boolean
6958
Default: no
6824
6959
6825
6960
Setting this variable will cause Mutt to always attempt to create an inline
6826
6961
(traditional) message when replying to a message which is PGP encrypted/signed
6834
6969
MIME messages when inline (traditional) would not work. See also: ``
6835
6970
$pgp_mime_auto''.
6836
6971
6837
Also note that using the old-style PGP message format is strongly deprecated.
6972
Also note that using the old-style PGP message format is stronglydeprecated.
6838
6973
(PGP only)
6839
6974
6840
3.161. pgp_show_unusable
6975
3.161. pgp_show_unusable
6841
6976
6842
Type: boolean
6843
Default: yes
6977
Type: boolean
6978
Default: yes
6844
6979
6845
6980
If set, mutt will display non-usable keys on the PGP key selection menu. This
6846
6981
includes keys which have been revoked, have expired, or have been marked as
6847
6982
``disabled'' by the user. (PGP only)
6848
6983
6849
3.162. pgp_sign_as
6984
3.162. pgp_sign_as
6850
6985
6851
Type: string
6852
Default: ""
6986
Type: string
6987
Default: ""
6853
6988
6854
6989
If you have more than one key pair, this option allows you to specify which of
6855
6990
your private keys to use. It is recommended that you use the keyid form to
6856
6991
specify your key (e.g., ``0x00112233''). (PGP only)
6857
6992
6858
3.163. pgp_strict_enc
6993
3.163. pgp_strict_enc
6859
6994
6860
Type: boolean
6861
Default: yes
6995
Type: boolean
6996
Default: yes
6862
6997
6863
6998
If set, Mutt will automatically encode PGP/MIME signed messages as
6864
6999
quoted-printable. Please note that unsetting this variable may lead to problems
6865
7000
with non-verifyable PGP signatures, so only change this if you know what you
6866
7001
are doing. (PGP only)
6867
7002
6868
3.164. pgp_timeout
7003
3.164. pgp_timeout
6869
7004
6870
Type: number
6871
Default: 300
7005
Type: number
7006
Default: 300
6872
7007
6873
7008
The number of seconds after which a cached passphrase will expire if not used.
6874
7009
(PGP only)
6875
7010
6876
3.165. pgp_sort_keys
7011
3.165. pgp_sort_keys
6877
7012
6878
Type: sort order
6879
Default: address
7013
Type: sort order
7014
Default: address
6880
7015
6881
7016
Specifies how the entries in the `pgp keys' menu are sorted. The following are
6882
7017
legal values:
6900
7035
If you prefer reverse order of the above values, prefix it with `reverse-'.
6901
7036
(PGP only)
6902
7037
6903
3.166. pgp_mime_auto
7038
3.166. pgp_mime_auto
6904
7039
6905
Type: quadoption
6906
Default: ask-yes
7040
Type: quadoption
7041
Default: ask-yes
6907
7042
6908
7043
This option controls whether Mutt will prompt you for automatically sending a
6909
7044
(signed/encrypted) message using PGP/MIME when inline (traditional) fails (for
6910
7045
any reason).
6911
7046
6912
Also note that using the old-style PGP message format is strongly deprecated.
7047
Also note that using the old-style PGP message format is stronglydeprecated.
6913
7048
(PGP only)
6914
7049
6915
3.167. pgp_auto_decode
7050
3.167. pgp_auto_decode
6916
7051
6917
Type: boolean
6918
Default: no
7052
Type: boolean
7053
Default: no
6919
7054
6920
7055
If set, mutt will automatically attempt to decrypt traditional PGP messages
6921
7056
whenever the user performs an operation which ordinarily would result in the
6924
7059
check-traditional-pgp function, mutt will automatically check the message for
6925
7060
traditional pgp.
6926
7061
6927
3.168. pgp_decode_command
7062
3.168. pgp_decode_command
6928
7063
6929
Type: string
6930
Default: ""
7064
Type: string
7065
Default: ""
6931
7066
6932
7067
This format strings specifies a command which is used to decode application/pgp
6933
7068
attachments.
6961
7096
subdirectory which has been installed on your system alongside the
6962
7097
documentation. (PGP only)
6963
7098
6964
3.169. pgp_getkeys_command
7099
3.169. pgp_getkeys_command
6965
7100
6966
Type: string
6967
Default: ""
7101
Type: string
7102
Default: ""
6968
7103
6969
7104
This command is invoked whenever mutt will need public key information. %r is
6970
7105
the only printf-like sequence used with this format. (PGP only)
6971
7106
6972
3.170. pgp_verify_command
7107
3.170. pgp_verify_command
6973
7108
6974
Type: string
6975
Default: ""
7109
Type: string
7110
Default: ""
6976
7111
6977
7112
This command is used to verify PGP signatures. (PGP only)
6978
7113
6979
3.171. pgp_decrypt_command
7114
3.171. pgp_decrypt_command
6980
7115
6981
Type: string
6982
Default: ""
7116
Type: string
7117
Default: ""
6983
7118
6984
7119
This command is used to decrypt a PGP encrypted message. (PGP only)
6985
7120
6986
3.172. pgp_clearsign_command
7121
3.172. pgp_clearsign_command
6987
7122
6988
Type: string
6989
Default: ""
7123
Type: string
7124
Default: ""
6990
7125
6991
7126
This format is used to create a old-style "clearsigned" PGP message. Note that
6992
the use of this format is strongly deprecated. (PGP only)
6993
6994
3.173. pgp_sign_command
6995
6996
Type: string
6997
Default: ""
7127
the use of this format is stronglydeprecated. (PGP only)
7128
7129
3.173. pgp_sign_command
7130
7131
Type: string
7132
Default: ""
6998
7133
6999
7134
This command is used to create the detached PGP signature for a multipart/
7000
7135
signed PGP/MIME body part. (PGP only)
7001
7136
7002
3.174. pgp_encrypt_sign_command
7137
3.174. pgp_encrypt_sign_command
7003
7138
7004
Type: string
7005
Default: ""
7139
Type: string
7140
Default: ""
7006
7141
7007
7142
This command is used to both sign and encrypt a body part. (PGP only)
7008
7143
7009
3.175. pgp_encrypt_only_command
7144
3.175. pgp_encrypt_only_command
7010
7145
7011
Type: string
7012
Default: ""
7146
Type: string
7147
Default: ""
7013
7148
7014
7149
This command is used to encrypt a body part without signing it. (PGP only)
7015
7150
7016
3.176. pgp_import_command
7151
3.176. pgp_import_command
7017
7152
7018
Type: string
7019
Default: ""
7153
Type: string
7154
Default: ""
7020
7155
7021
7156
This command is used to import a key from a message into the user's public key
7022
7157
ring. (PGP only)
7023
7158
7024
3.177. pgp_export_command
7159
3.177. pgp_export_command
7025
7160
7026
Type: string
7027
Default: ""
7161
Type: string
7162
Default: ""
7028
7163
7029
7164
This command is used to export a public key from the user's key ring. (PGP
7030
7165
only)
7031
7166
7032
3.178. pgp_verify_key_command
7167
3.178. pgp_verify_key_command
7033
7168
7034
Type: string
7035
Default: ""
7169
Type: string
7170
Default: ""
7036
7171
7037
7172
This command is used to verify key information from the key selection menu.
7038
7173
(PGP only)
7039
7174
7040
3.179. pgp_list_secring_command
7175
3.179. pgp_list_secring_command
7041
7176
7042
Type: string
7043
Default: ""
7177
Type: string
7178
Default: ""
7044
7179
7045
7180
This command is used to list the secret key ring's contents. The output format
7046
7181
must be analogous to the one used by gpg --list-keys --with-colons.
7048
7183
This format is also generated by the pgpring utility which comes with mutt.
7049
7184
(PGP only)
7050
7185
7051
3.180. pgp_list_pubring_command
7186
3.180. pgp_list_pubring_command
7052
7187
7053
Type: string
7054
Default: ""
7188
Type: string
7189
Default: ""
7055
7190
7056
7191
This command is used to list the public key ring's contents. The output format
7057
7192
must be analogous to the one used by gpg --list-keys --with-colons.
7059
7194
This format is also generated by the pgpring utility which comes with mutt.
7060
7195
(PGP only)
7061
7196
7062
3.181. forward_decrypt
7197
3.181. forward_decrypt
7063
7198
7064
Type: boolean
7065
Default: yes
7199
Type: boolean
7200
Default: yes
7066
7201
7067
7202
Controls the handling of encrypted messages when forwarding a message. When
7068
7203
set, the outer layer of encryption is stripped off. This variable is only used
7069
7204
if ``$mime_forward'' is set and ``$mime_forward_decode'' is unset. (PGP only)
7070
7205
7071
3.182. smime_timeout
7206
3.182. smime_timeout
7072
7207
7073
Type: number
7074
Default: 300
7208
Type: number
7209
Default: 300
7075
7210
7076
7211
The number of seconds after which a cached passphrase will expire if not used.
7077
7212
(S/MIME only)
7078
7213
7079
3.183. smime_encrypt_with
7214
3.183. smime_encrypt_with
7080
7215
7081
Type: string
7082
Default: ""
7216
Type: string
7217
Default: ""
7083
7218
7084
7219
This sets the algorithm that should be used for encryption. Valid choices are
7085
7220
"des", "des3", "rc2-40", "rc2-64", "rc2-128". If unset "3des" (TripleDES) is
7086
7221
used. (S/MIME only)
7087
7222
7088
3.184. smime_keys
7223
3.184. smime_keys
7089
7224
7090
Type: path
7091
Default: ""
7225
Type: path
7226
Default: ""
7092
7227
7093
7228
Since there is no pubring/secring as with PGP, mutt has to handle storage ad
7094
7229
retrieval of keys/certs by itself. This is very basic right now, and stores
7097
7232
mailbox-address keyid pair, and which can be manually edited. This one points
7098
7233
to the location of the private keys. (S/MIME only)
7099
7234
7100
3.185. smime_ca_location
7235
3.185. smime_ca_location
7101
7236
7102
Type: path
7103
Default: ""
7237
Type: path
7238
Default: ""
7104
7239
7105
7240
This variable contains the name of either a directory, or a file which contains
7106
7241
trusted certificates for use with OpenSSL. (S/MIME only)
7107
7242
7108
3.186. smime_certificates
7243
3.186. smime_certificates
7109
7244
7110
Type: path
7111
Default: ""
7245
Type: path
7246
Default: ""
7112
7247
7113
7248
Since there is no pubring/secring as with PGP, mutt has to handle storage and
7114
7249
retrieval of keys by itself. This is very basic right now, and keys and
7117
7252
mailbox-address keyid pairs, and which can be manually edited. This one points
7118
7253
to the location of the certificates. (S/MIME only)
7119
7254
7120
3.187. smime_decrypt_command
7255
3.187. smime_decrypt_command
7121
7256
7122
Type: string
7123
Default: ""
7257
Type: string
7258
Default: ""
7124
7259
7125
7260
This format string specifies a command which is used to decrypt application/
7126
7261
x-pkcs7-mime attachments.
7159
7294
/ subdirectory which has been installed on your system alongside the
7160
7295
documentation. (S/MIME only)
7161
7296
7162
3.188. smime_verify_command
7297
3.188. smime_verify_command
7163
7298
7164
Type: string
7165
Default: ""
7299
Type: string
7300
Default: ""
7166
7301
7167
7302
This command is used to verify S/MIME signatures of type multipart/signed. (S/
7168
7303
MIME only)
7169
7304
7170
3.189. smime_verify_opaque_command
7305
3.189. smime_verify_opaque_command
7171
7306
7172
Type: string
7173
Default: ""
7307
Type: string
7308
Default: ""
7174
7309
7175
7310
This command is used to verify S/MIME signatures of type application/
7176
7311
x-pkcs7-mime. (S/MIME only)
7177
7312
7178
3.190. smime_sign_command
7313
3.190. smime_sign_command
7179
7314
7180
Type: string
7181
Default: ""
7315
Type: string
7316
Default: ""
7182
7317
7183
7318
This command is used to created S/MIME signatures of type multipart/signed,
7184
7319
which can be read by all mail clients. (S/MIME only)
7185
7320
7186
3.191. smime_sign_opaque_command
7321
3.191. smime_sign_opaque_command
7187
7322
7188
Type: string
7189
Default: ""
7323
Type: string
7324
Default: ""
7190
7325
7191
7326
This command is used to created S/MIME signatures of type application/
7192
7327
x-pkcs7-signature, which can only be handled by mail clients supporting the S/
7193
7328
MIME extension. (S/MIME only)
7194
7329
7195
3.192. smime_encrypt_command
7330
3.192. smime_encrypt_command
7196
7331
7197
Type: string
7198
Default: ""
7332
Type: string
7333
Default: ""
7199
7334
7200
7335
This command is used to create encrypted S/MIME messages. (S/MIME only)
7201
7336
7202
3.193. smime_pk7out_command
7337
3.193. smime_pk7out_command
7203
7338
7204
Type: string
7205
Default: ""
7339
Type: string
7340
Default: ""
7206
7341
7207
7342
This command is used to extract PKCS7 structures of S/MIME signatures, in order
7208
7343
to extract the public X509 certificate(s). (S/MIME only)
7209
7344
7210
3.194. smime_get_cert_command
7345
3.194. smime_get_cert_command
7211
7346
7212
Type: string
7213
Default: ""
7347
Type: string
7348
Default: ""
7214
7349
7215
7350
This command is used to extract X509 certificates from a PKCS7 structure. (S/
7216
7351
MIME only)
7217
7352
7218
3.195. smime_get_signer_cert_command
7353
3.195. smime_get_signer_cert_command
7219
7354
7220
Type: string
7221
Default: ""
7355
Type: string
7356
Default: ""
7222
7357
7223
7358
This command is used to extract only the signers X509 certificate from a S/MIME
7224
7359
signature, so that the certificate's owner may get compared to the email's
7225
7360
'From'-field. (S/MIME only)
7226
7361
7227
3.196. smime_import_cert_command
7362
3.196. smime_import_cert_command
7228
7363
7229
Type: string
7230
Default: ""
7364
Type: string
7365
Default: ""
7231
7366
7232
7367
This command is used to import a certificate via smime_keys. (S/MIME only)
7233
7368
7234
3.197. smime_get_cert_email_command
7369
3.197. smime_get_cert_email_command
7235
7370
7236
Type: string
7237
Default: ""
7371
Type: string
7372
Default: ""
7238
7373
7239
7374
This command is used to extract the mail address(es) used for storing X509
7240
7375
certificates, and for verification purposes (to check whether the certificate
7241
7376
was issued for the sender's mailbox). (S/MIME only)
7242
7377
7243
3.198. smime_default_key
7378
3.198. smime_default_key
7244
7379
7245
Type: string
7246
Default: ""
7380
Type: string
7381
Default: ""
7247
7382
7248
7383
This is the default key-pair to use for signing. This must be set to the keyid
7249
7384
(the hash-value that OpenSSL generates) to work properly (S/MIME only)
7250
7385
7251
3.199. ssl_client_cert
7386
3.199. ssl_client_cert
7252
7387
7253
Type: path
7254
Default: ""
7388
Type: path
7389
Default: ""
7255
7390
7256
7391
The file containing a client certificate and its associated private key.
7257
7392
7258
3.200. ssl_force_tls
7393
3.200. ssl_force_tls
7259
7394
7260
Type: boolean
7261
Default: no
7395
Type: boolean
7396
Default: no
7262
7397
7263
7398
If this variable is set, Mutt will require that all connections to remote
7264
7399
servers be encrypted. Furthermore it will attempt to negotiate TLS even if the
7265
7400
server does not advertise the capability, since it would otherwise have to
7266
7401
abort the connection anyway. This option supersedes ``$ssl_starttls''.
7267
7402
7268
3.201. ssl_starttls
7403
3.201. ssl_starttls
7269
7404
7270
Type: quadoption
7271
Default: yes
7405
Type: quadoption
7406
Default: yes
7272
7407
7273
7408
If set (the default), mutt will attempt to use STARTTLS on servers advertising
7274
7409
the capability. When unset, mutt will not attempt to use STARTTLS regardless of
7275
7410
the server's capabilities.
7276
7411
7277
3.202. certificate_file
7412
3.202. certificate_file
7278
7413
7279
Type: path
7280
Default: "˜/.mutt_certificates"
7414
Type: path
7415
Default: "~/.mutt_certificates"
7281
7416
7282
7417
This variable specifies the file where the certificates you trust are saved.
7283
7418
When an unknown certificate is encountered, you are asked if you accept it or
7288
7423
that is signed with one of these CA certificates are also automatically
7289
7424
accepted.
7290
7425
7291
Example: set certificate_file=˜/.mutt/certificates
7292
7293
3.203. ssl_usesystemcerts
7294
7295
Type: boolean
7296
Default: yes
7426
Example: set certificate_file=~/.mutt/certificates
7427
7428
3.203. ssl_usesystemcerts
7429
7430
Type: boolean
7431
Default: yes
7297
7432
7298
7433
If set to yes, mutt will use CA certificates in the system-wide certificate
7299
7434
store when checking if server certificate is signed by a trusted CA.
7300
7435
7301
3.204. entropy_file
7436
3.204. entropy_file
7302
7437
7303
Type: path
7304
Default: ""
7438
Type: path
7439
Default: ""
7305
7440
7306
7441
The file which includes random data that is used to initialize SSL library
7307
7442
functions.
7308
7443
7309
3.205. ssl_use_sslv2
7444
3.205. ssl_use_sslv2
7310
7445
7311
Type: boolean
7312
Default: yes
7446
Type: boolean
7447
Default: yes
7313
7448
7314
7449
This variables specifies whether to attempt to use SSLv2 in the SSL
7315
7450
authentication process.
7316
7451
7317
3.206. ssl_use_sslv3
7452
3.206. ssl_use_sslv3
7318
7453
7319
Type: boolean
7320
Default: yes
7454
Type: boolean
7455
Default: yes
7321
7456
7322
7457
This variables specifies whether to attempt to use SSLv3 in the SSL
7323
7458
authentication process.
7324
7459
7325
3.207. ssl_use_tlsv1
7460
3.207. ssl_use_tlsv1
7326
7461
7327
Type: boolean
7328
Default: yes
7462
Type: boolean
7463
Default: yes
7329
7464
7330
7465
This variables specifies whether to attempt to use TLSv1 in the SSL
7331
7466
authentication process.
7332
7467
7333
3.208. ssl_min_dh_prime_bits
7468
3.208. ssl_min_dh_prime_bits
7334
7469
7335
Type: number
7336
Default: 0
7470
Type: number
7471
Default: 0
7337
7472
7338
7473
This variable specifies the minimum acceptable prime size (in bits) for use in
7339
7474
any Diffie-Hellman key exchange. A value of 0 will use the default from the
7340
7475
GNUTLS library.
7341
7476
7342
3.209. ssl_ca_certificates_file
7477
3.209. ssl_ca_certificates_file
7343
7478
7344
Type: path
7345
Default: ""
7479
Type: path
7480
Default: ""
7346
7481
7347
7482
This variable specifies a file containing trusted CA certificates. Any server
7348
7483
certificate that is signed with one of these CA certificates are also
7350
7485
7351
7486
Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
7352
7487
7353
3.210. pipe_split
7488
3.210. pipe_split
7354
7489
7355
Type: boolean
7356
Default: no
7490
Type: boolean
7491
Default: no
7357
7492
7358
7493
Used in connection with the pipe-message command and the ``tag- prefix''
7359
7494
operator. If this variable is unset, when piping a list of tagged messages Mutt
7362
7497
the current sorted order, and the ``$pipe_sep'' separator is added after each
7363
7498
message.
7364
7499
7365
3.211. pipe_decode
7500
3.211. pipe_decode
7366
7501
7367
Type: boolean
7368
Default: no
7502
Type: boolean
7503
Default: no
7369
7504
7370
7505
Used in connection with the pipe-message command. When unset, Mutt will pipe
7371
7506
the messages without any preprocessing. When set, Mutt will weed headers and
7372
7507
will attempt to PGP/MIME decode the messages first.
7373
7508
7374
3.212. pipe_sep
7509
3.212. pipe_sep
7375
7510
7376
Type: string
7377
Default: "\n"
7511
Type: string
7512
Default: "\n"
7378
7513
7379
7514
The separator to add between messages when piping a list of tagged messages to
7380
7515
an external Unix command.
7381
7516
7382
3.213. pop_authenticators
7517
3.213. pop_authenticators
7383
7518
7384
Type: string
7385
Default: ""
7519
Type: string
7520
Default: ""
7386
7521
7387
7522
This is a colon-delimited list of authentication methods mutt may attempt to
7388
7523
use to log in to an POP server, in the order mutt should try them.
7393
7528
7394
7529
Example: set pop_authenticators="digest-md5:apop:user"
7395
7530
7396
3.214. pop_auth_try_all
7531
3.214. pop_auth_try_all
7397
7532
7398
Type: boolean
7399
Default: yes
7533
Type: boolean
7534
Default: yes
7400
7535
7401
7536
If set, Mutt will try all available methods. When unset, Mutt will only fall
7402
7537
back to other authentication methods if the previous methods are unavailable.
7403
7538
If a method is available but authentication fails, Mutt will not connect to the
7404
7539
POP server.
7405
7540
7406
3.215. pop_checkinterval
7541
3.215. pop_checkinterval
7407
7542
7408
Type: number
7409
Default: 60
7543
Type: number
7544
Default: 60
7410
7545
7411
7546
This variable configures how often (in seconds) mutt should look for new mail
7412
7547
in the currently selected mailbox if it is a POP mailbox.
7413
7548
7414
3.216. pop_delete
7549
3.216. pop_delete
7415
7550
7416
Type: quadoption
7417
Default: ask-no
7551
Type: quadoption
7552
Default: ask-no
7418
7553
7419
7554
If set, Mutt will delete successfully downloaded messages from the POP server
7420
7555
when using the fetch-mail function. When unset, Mutt will download messages but
7421
7556
also leave them on the POP server.
7422
7557
7423
3.217. pop_host
7558
3.217. pop_host
7424
7559
7425
Type: string
7426
Default: ""
7560
Type: string
7561
Default: ""
7427
7562
7428
7563
The name of your POP server for the fetch-mail function. You can also specify
7429
7564
an alternative port, username and password, ie:
7430
7565
7431
7566
[pop[s]://][username[:password]@]popserver[:port]
7432
7567
7433
3.218. pop_last
7568
3.218. pop_last
7434
7569
7435
Type: boolean
7436
Default: no
7570
Type: boolean
7571
Default: no
7437
7572
7438
7573
If this variable is set, mutt will try to use the "LAST" POP command for
7439
7574
retrieving only unread messages from the POP server when using the fetch-mail
7440
7575
function.
7441
7576
7442
3.219. pop_reconnect
7577
3.219. pop_reconnect
7443
7578
7444
Type: quadoption
7445
Default: ask-yes
7579
Type: quadoption
7580
Default: ask-yes
7446
7581
7447
7582
Controls whether or not Mutt will try to reconnect to POP server if the
7448
7583
connection is lost.
7449
7584
7450
3.220. pop_user
7585
3.220. pop_user
7451
7586
7452
Type: string
7453
Default: ""
7587
Type: string
7588
Default: ""
7454
7589
7455
7590
Your login name on the POP server.
7456
7591
7457
7592
This variable defaults to your user name on the local machine.
7458
7593
7459
3.221. pop_pass
7594
3.221. pop_pass
7460
7595
7461
Type: string
7462
Default: ""
7596
Type: string
7597
Default: ""
7463
7598
7464
7599
Specifies the password for your POP account. If unset, Mutt will prompt you for
7465
7600
your password when you open POP mailbox. Warning: you should only use this
7466
7601
option when you are on a fairly secure machine, because the superuser can read
7467
7602
your muttrc even if you are the only one who can read the file.
7468
7603
7469
3.222. post_indent_string
7604
3.222. post_indent_string
7470
7605
7471
Type: string
7472
Default: ""
7606
Type: string
7607
Default: ""
7473
7608
7474
7609
Similar to the ``$attribution'' variable, Mutt will append this string after
7475
7610
the inclusion of a message which is being replied to.
7476
7611
7477
3.223. postpone
7612
3.223. postpone
7478
7613
7479
Type: quadoption
7480
Default: ask-yes
7614
Type: quadoption
7615
Default: ask-yes
7481
7616
7482
7617
Controls whether or not messages are saved in the ``$postponed'' mailbox when
7483
you elect not to send immediately.
7484
7485
3.224. postponed
7486
7487
Type: path
7488
Default: "˜/postponed"
7618
you elect not to send immediately. Also see the ``$recall'' variable.
7619
7620
3.224. postponed
7621
7622
Type: path
7623
Default: "~/postponed"
7489
7624
7490
7625
Mutt allows you to indefinitely ``postpone sending a message'' which you are
7491
7626
editing. When you choose to postpone a message, Mutt saves it in the mailbox
7492
7627
specified by this variable. Also see the ``$postpone'' variable.
7493
7628
7494
3.225. preconnect
7629
3.225. preconnect
7495
7630
7496
Type: string
7497
Default: ""
7631
Type: string
7632
Default: ""
7498
7633
7499
7634
If set, a shell command to be executed if mutt fails to establish a connection
7500
7635
to the server. This is useful for setting up secure connections, e.g. with ssh
7509
7644
NOTE: For this example to work, you must be able to log in to the remote
7510
7645
machine without having to enter a password.
7511
7646
7512
3.226. print
7647
3.226. print
7513
7648
7514
Type: quadoption
7515
Default: ask-no
7649
Type: quadoption
7650
Default: ask-no
7516
7651
7517
7652
Controls whether or not Mutt really prints messages. This is set to ask-no by
7518
7653
default, because some people accidentally hit ``p'' often (like me).
7519
7654
7520
3.227. print_command
7655
3.227. print_command
7521
7656
7522
Type: path
7523
Default: "lpr"
7657
Type: path
7658
Default: "lpr"
7524
7659
7525
7660
This specifies the command pipe that should be used to print messages.
7526
7661
7527
3.228. print_decode
7662
3.228. print_decode
7528
7663
7529
Type: boolean
7530
Default: yes
7664
Type: boolean
7665
Default: yes
7531
7666
7532
7667
Used in connection with the print-message command. If this option is set, the
7533
7668
message is decoded before it is passed to the external command specified by
7536
7671
some advanced printer filter which is able to properly format e-mail messages
7537
7672
for printing.
7538
7673
7539
3.229. print_split
7674
3.229. print_split
7540
7675
7541
Type: boolean
7542
Default: no
7676
Type: boolean
7677
Default: no
7543
7678
7544
7679
Used in connection with the print-message command. If this option is set, the
7545
7680
command specified by $print_command is executed once for each message which is
7550
7685
Those who use the enscript(1) program's mail-printing mode will most likely
7551
7686
want to set this option.
7552
7687
7553
3.230. prompt_after
7688
3.230. prompt_after
7554
7689
7555
Type: boolean
7556
Default: yes
7690
Type: boolean
7691
Default: yes
7557
7692
7558
7693
If you use an external ``$pager'', setting this variable will cause Mutt to
7559
7694
prompt you for a command when the pager exits rather than returning to the
7560
7695
index menu. If unset, Mutt will return to the index menu when the external
7561
7696
pager exits.
7562
7697
7563
3.231. query_command
7698
3.231. query_command
7564
7699
7565
Type: path
7566
Default: ""
7700
Type: path
7701
Default: ""
7567
7702
7568
7703
This specifies the command that mutt will use to make external address queries.
7569
7704
The string should contain a %s, which will be substituted with the query string
7570
7705
the user types. See ``query'' for more information.
7571
7706
7572
3.232. quit
7707
3.232. quit
7573
7708
7574
Type: quadoption
7575
Default: yes
7709
Type: quadoption
7710
Default: yes
7576
7711
7577
7712
This variable controls whether ``quit'' and ``exit'' actually quit from mutt.
7578
7713
If it set to yes, they do quit, if it is set to no, they have no effect, and if
7579
7714
it is set to ask-yes or ask-no, you are prompted for confirmation when you try
7580
7715
to quit.
7581
7716
7582
3.233. quote_regexp
7717
3.233. quote_regexp
7583
7718
7584
Type: regular expression
7585
Default: "^([ \t]*[|>:}#])+"
7719
Type: regular expression
7720
Default: "^([ \t]*[|>:}#])+"
7586
7721
7587
7722
A regular expression used in the internal-pager to determine quoted sections of
7588
7723
text in the body of a message.
7591
7726
set this to a regular expression that matches exactly the quote characters at
7592
7727
the beginning of quoted lines.
7593
7728
7594
3.234. read_inc
7729
3.234. read_inc
7595
7730
7596
Type: number
7597
Default: 10
7731
Type: number
7732
Default: 10
7598
7733
7599
7734
If set to a value greater than 0, Mutt will display which message it is
7600
7735
currently on when reading a mailbox or when performing search actions such as
7608
7743
Also see the ``$write_inc'' variable and the ``Tuning'' section of the manual
7609
7744
for performance considerations.
7610
7745
7611
3.235. read_only
7746
3.235. read_only
7612
7747
7613
Type: boolean
7614
Default: no
7748
Type: boolean
7749
Default: no
7615
7750
7616
7751
If set, all folders are opened in read-only mode.
7617
7752
7618
3.236. realname
7753
3.236. realname
7619
7754
7620
Type: string
7621
Default: ""
7755
Type: string
7756
Default: ""
7622
7757
7623
7758
This variable specifies what "real" or "personal" name should be used when
7624
7759
sending messages.
7626
7761
By default, this is the GECOS field from /etc/passwd. Note that this variable
7627
7762
will not be used when the user has set a real name in the $from variable.
7628
7763
7629
3.237. recall
7764
3.237. recall
7630
7765
7631
Type: quadoption
7632
Default: ask-yes
7766
Type: quadoption
7767
Default: ask-yes
7633
7768
7634
7769
Controls whether or not Mutt recalls postponed messages when composing a new
7635
7770
message. Also see ``$postponed''.
7637
7772
Setting this variable to ``yes'' is not generally useful, and thus not
7638
7773
recommended.
7639
7774
7640
3.238. record
7775
3.238. record
7641
7776
7642
Type: path
7643
Default: "˜/sent"
7777
Type: path
7778
Default: "~/sent"
7644
7779
7645
7780
This specifies the file into which your outgoing messages should be appended.
7646
7781
(This is meant as the primary method for saving a copy of your messages, but
7650
7785
The value of $record is overridden by the ``$force_name'' and ``$save_name''
7651
7786
variables, and the ``fcc-hook'' command.
7652
7787
7653
3.239. reply_regexp
7788
3.239. reply_regexp
7654
7789
7655
Type: regular expression
7656
Default: "^(re([\[0-9\]+])*|aw):[ \t]*"
7790
Type: regular expression
7791
Default: "^(re([\[0-9\]+])*|aw):[ \t]*"
7657
7792
7658
7793
A regular expression used to recognize reply messages when threading and
7659
7794
replying. The default value corresponds to the English "Re:" and the German
7660
7795
"Aw:".
7661
7796
7662
3.240. reply_self
7797
3.240. reply_self
7663
7798
7664
Type: boolean
7665
Default: no
7799
Type: boolean
7800
Default: no
7666
7801
7667
7802
If unset and you are replying to a message sent by you, Mutt will assume that
7668
7803
you want to reply to the recipients of that message rather than to yourself.
7669
7804
7670
3.241. reply_to
7805
3.241. reply_to
7671
7806
7672
Type: quadoption
7673
Default: ask-yes
7807
Type: quadoption
7808
Default: ask-yes
7674
7809
7675
7810
If set, when replying to a message, Mutt will use the address listed in the
7676
7811
Reply-to: header as the recipient of the reply. If unset, it will use the
7678
7813
mailing list that sets the Reply-To: header field to the list address and you
7679
7814
want to send a private message to the author of a message.
7680
7815
7681
3.242. resolve
7816
3.242. resolve
7682
7817
7683
Type: boolean
7684
Default: yes
7818
Type: boolean
7819
Default: yes
7685
7820
7686
7821
When set, the cursor will be automatically advanced to the next (possibly
7687
7822
undeleted) message whenever a command that modifies the current message is
7688
7823
executed.
7689
7824
7690
3.243. reverse_alias
7825
3.243. reverse_alias
7691
7826
7692
Type: boolean
7693
Default: no
7827
Type: boolean
7828
Default: no
7694
7829
7695
7830
This variable controls whether or not Mutt will display the "personal" name
7696
7831
from your aliases in the index menu if it finds an alias that matches the
7708
7843
``abd30425@somewhere.net.'' This is useful when the person's e-mail address is
7709
7844
not human friendly (like CompuServe addresses).
7710
7845
7711
3.244. reverse_name
7846
3.244. reverse_name
7712
7847
7713
Type: boolean
7714
Default: no
7848
Type: boolean
7849
Default: no
7715
7850
7716
7851
It may sometimes arrive that you receive mail to a certain machine, move the
7717
7852
messages to another machine, and reply to some the messages from there. If this
7721
7856
used doesn't match your alternates, the From: line will use your address on the
7722
7857
current machine.
7723
7858
7724
3.245. reverse_realname
7859
3.245. reverse_realname
7725
7860
7726
Type: boolean
7727
Default: yes
7861
Type: boolean
7862
Default: yes
7728
7863
7729
7864
This variable fine-tunes the behaviour of the reverse_name feature. When it is
7730
7865
set, mutt will use the address from incoming messages as-is, possibly including
7731
7866
eventual real names. When it is unset, mutt will override any such real names
7732
7867
with the setting of the realname variable.
7733
7868
7734
3.246. rfc2047_parameters
7869
3.246. rfc2047_parameters
7735
7870
7736
Type: boolean
7737
Default: no
7871
Type: boolean
7872
Default: no
7738
7873
7739
7874
When this variable is set, Mutt will decode RFC-2047-encoded MIME parameters.
7740
7875
You want to set this variable when mutt suggests you to save attachments to
7748
7883
parameter will not have the effect that mutt generates this kind of encoding.
7749
7884
Instead, mutt will unconditionally use the encoding specified in RFC 2231.
7750
7885
7751
3.247. save_address
7886
3.247. save_address
7752
7887
7753
Type: boolean
7754
Default: no
7888
Type: boolean
7889
Default: no
7755
7890
7756
7891
If set, mutt will take the sender's full address when choosing a default folder
7757
7892
for saving a mail. If ``$save_name'' or ``$force_name'' is set too, the
7758
7893
selection of the fcc folder will be changed as well.
7759
7894
7760
3.248. save_empty
7895
3.248. save_empty
7761
7896
7762
Type: boolean
7763
Default: yes
7897
Type: boolean
7898
Default: yes
7764
7899
7765
7900
When unset, mailboxes which contain no saved messages will be removed when
7766
7901
closed (the exception is ``$spoolfile'' which is never removed). If set,
7769
7904
Note: This only applies to mbox and MMDF folders, Mutt does not delete MH and
7770
7905
Maildir directories.
7771
7906
7772
3.249. save_history
7907
3.249. save_history
7773
7908
7774
Type: number
7775
Default: 0
7909
Type: number
7910
Default: 0
7776
7911
7777
7912
This variable controls the size of the history saved in the ``$history_file''
7778
7913
file.
7779
7914
7780
3.250. save_name
7915
3.250. save_name
7781
7916
7782
Type: boolean
7783
Default: no
7917
Type: boolean
7918
Default: no
7784
7919
7785
7920
This variable controls how copies of outgoing messages are saved. When set, a
7786
7921
check is made to see if a mailbox specified by the recipient address exists
7791
7926
7792
7927
Also see the ``$force_name'' variable.
7793
7928
7794
3.251. score
7929
3.251. score
7795
7930
7796
Type: boolean
7797
Default: yes
7931
Type: boolean
7932
Default: yes
7798
7933
7799
7934
When this variable is unset, scoring is turned off. This can be useful to
7800
7935
selectively disable scoring for certain folders when the ``
7801
7936
$score_threshold_delete'' variable and friends are used.
7802
7937
7803
3.252. score_threshold_delete
7938
3.252. score_threshold_delete
7804
7939
7805
Type: number
7806
Default: -1
7940
Type: number
7941
Default: -1
7807
7942
7808
7943
Messages which have been assigned a score equal to or lower than the value of
7809
7944
this variable are automatically marked for deletion by mutt. Since mutt scores
7810
7945
are always greater than or equal to zero, the default setting of this variable
7811
7946
will never mark a message for deletion.
7812
7947
7813
3.253. score_threshold_flag
7948
3.253. score_threshold_flag
7814
7949
7815
Type: number
7816
Default: 9999
7950
Type: number
7951
Default: 9999
7817
7952
7818
7953
Messages which have been assigned a score greater than or equal to this
7819
7954
variable's value are automatically marked "flagged".
7820
7955
7821
3.254. score_threshold_read
7956
3.254. score_threshold_read
7822
7957
7823
Type: number
7824
Default: -1
7958
Type: number
7959
Default: -1
7825
7960
7826
7961
Messages which have been assigned a score equal to or lower than the value of
7827
7962
this variable are automatically marked as read by mutt. Since mutt scores are
7828
7963
always greater than or equal to zero, the default setting of this variable will
7829
7964
never mark a message read.
7830
7965
7831
3.255. send_charset
7966
3.255. send_charset
7832
7967
7833
Type: string
7834
Default: "us-ascii:iso-8859-1:utf-8"
7968
Type: string
7969
Default: "us-ascii:iso-8859-1:utf-8"
7835
7970
7836
7971
A colon-delimited list of character sets for outgoing messages. Mutt will use
7837
7972
the first character set into which the text can be converted exactly. If your
7843
7978
In case the text cannot be converted into one of these exactly, mutt uses ``
7844
7979
$charset'' as a fallback.
7845
7980
7846
3.256. sendmail
7981
3.256. sendmail
7847
7982
7848
Type: path
7849
Default: "/usr/sbin/sendmail -oem -oi"
7983
Type: path
7984
Default: "/usr/sbin/sendmail -oem -oi"
7850
7985
7851
7986
Specifies the program and arguments used to deliver mail sent by Mutt. Mutt
7852
7987
expects that the specified program interprets additional arguments as recipient
7853
7988
addresses.
7854
7989
7855
3.257. sendmail_wait
7990
3.257. sendmail_wait
7856
7991
7857
Type: number
7858
Default: 0
7992
Type: number
7993
Default: 0
7859
7994
7860
7995
Specifies the number of seconds to wait for the ``$sendmail'' process to finish
7861
7996
before giving up and putting delivery in the background.
7878
8013
will be put in a temporary file. If there is some error, you will be informed
7879
8014
as to where to find the output.
7880
8015
7881
3.258. shell
8016
3.258. shell
7882
8017
7883
Type: path
7884
Default: ""
8018
Type: path
8019
Default: ""
7885
8020
7886
8021
Command to use when spawning a subshell. By default, the user's login shell
7887
8022
from /etc/passwd is used.
7888
8023
7889
3.259. sig_dashes
8024
3.259. sig_dashes
7890
8025
7891
Type: boolean
7892
Default: yes
8026
Type: boolean
8027
Default: yes
7893
8028
7894
8029
If set, a line containing ``-- '' will be inserted before your ``$signature''.
7895
8030
It is strongly recommended that you not unset this variable unless your
7898
8033
the ability to highlight the signature in a different color in the builtin
7899
8034
pager.
7900
8035
7901
3.260. sig_on_top
8036
3.260. sig_on_top
7902
8037
7903
Type: boolean
7904
Default: no
8038
Type: boolean
8039
Default: no
7905
8040
7906
8041
If set, the signature will be included before any quoted or forwarded text. It
7907
8042
is strongly recommended that you do not set this variable unless you really
7908
8043
know what you are doing, and are prepared to take some heat from netiquette
7909
8044
guardians.
7910
8045
7911
3.261. signature
8046
3.261. signature
7912
8047
7913
Type: path
7914
Default: "˜/.signature"
8048
Type: path
8049
Default: "~/.signature"
7915
8050
7916
8051
Specifies the filename of your signature, which is appended to all outgoing
7917
8052
messages. If the filename ends with a pipe (``|''), it is assumed that filename
7918
8053
is a shell command and input should be read from its stdout.
7919
8054
7920
3.262. simple_search
8055
3.262. simple_search
7921
8056
7922
Type: string
7923
Default: "˜f %s | ˜s %s"
8057
Type: string
8058
Default: "~f %s | ~s %s"
7924
8059
7925
8060
Specifies how Mutt should expand a simple search into a real search pattern. A
7926
simple search is one that does not contain any of the ˜ operators. See ``
8061
simple search is one that does not contain any of the ~ operators. See ``
7927
8062
patterns'' for more information on search patterns.
7928
8063
7929
8064
For example, if you simply type joe at a search or limit prompt, Mutt will
7930
8065
automatically expand it to the value specified by this variable. For the
7931
8066
default value it would be:
7932
8067
7933
˜f joe | ˜s joe
7934
7935
3.263. smart_wrap
7936
7937
Type: boolean
7938
Default: yes
8068
~f joe | ~s joe
8069
8070
3.263. smart_wrap
8071
8072
Type: boolean
8073
Default: yes
7939
8074
7940
8075
Controls the display of lines longer than the screen width in the internal
7941
8076
pager. If set, long lines are wrapped at a word boundary. If unset, lines are
7942
8077
simply wrapped at the screen edge. Also see the ``$markers'' variable.
7943
8078
7944
3.264. smileys
8079
3.264. smileys
7945
8080
7946
Type: regular expression
7947
Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
8081
Type: regular expression
8082
Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
7948
8083
7949
8084
The pager uses this variable to catch some common false positives of ``
7950
8085
$quote_regexp'', most notably smileys in the beginning of a line
7951
8086
7952
3.265. sleep_time
8087
3.265. sleep_time
7953
8088
7954
Type: number
7955
Default: 1
8089
Type: number
8090
Default: 1
7956
8091
7957
8092
Specifies time, in seconds, to pause while displaying certain informational
7958
8093
messages, while moving from folder to folder and after expunging messages from
7959
8094
the current folder. The default is to pause one second, so a value of zero for
7960
8095
this option suppresses the pause.
7961
8096
7962
3.266. smtp_authenticators
8097
3.266. smtp_authenticators
7963
8098
7964
Type: string
7965
Default: ""
8099
Type: string
8100
Default: ""
7966
8101
7967
8102
This is a colon-delimited list of authentication methods mutt may attempt to
7968
8103
use to log in to an SMTP server, in the order mutt should try them.
7973
8108
7974
8109
Example: set smtp_authenticators="digest-md5:cram-md5"
7975
8110
7976
3.267. smtp_pass
8111
3.267. smtp_pass
7977
8112
7978
Type: string
7979
Default: ""
8113
Type: string
8114
Default: ""
7980
8115
7981
8116
Specifies the password for your SMTP account. If unset, Mutt will prompt you
7982
8117
for your password when you first send mail via SMTP. See ``smtp_url'' to
7984
8119
when you are on a fairly secure machine, because the superuser can read your
7985
8120
muttrc even if you are the only one who can read the file.
7986
8121
7987
3.268. smtp_url
8122
3.268. smtp_url
7988
8123
7989
Type: string
7990
Default: ""
8124
Type: string
8125
Default: ""
7991
8126
7992
8127
Defines the SMTP ``smart'' host where sent messages should relayed for
7993
8128
delivery. This should take the form of an SMTP URL, eg:
7996
8131
7997
8132
Setting this variable overrides the value of the ``$sendmail'' variable.
7998
8133
7999
3.269. sort
8134
3.269. sort
8000
8135
8001
Type: sort order
8002
Default: date
8136
Type: sort order
8137
Default: date
8003
8138
8004
8139
Specifies how to sort messages in the index menu. Valid values are:
8005
8140
8018
8153
You may optionally use the reverse- prefix to specify reverse sorting order
8019
8154
(example: set sort=reverse-date-sent).
8020
8155
8021
3.270. sort_alias
8156
3.270. sort_alias
8022
8157
8023
Type: sort order
8024
Default: alias
8158
Type: sort order
8159
Default: alias
8025
8160
8026
8161
Specifies how the entries in the `alias' menu are sorted. The following are
8027
8162
legal values:
8031
8166
unsorted (leave in order specified in .muttrc)
8032
8167
8033
8168
8034
3.271. sort_aux
8169
3.271. sort_aux
8035
8170
8036
Type: sort order
8037
Default: date
8171
Type: sort order
8172
Default: date
8038
8173
8039
8174
When sorting by threads, this variable controls how threads are sorted in
8040
8175
relation to other threads, and how the branches of the thread trees are sorted.
8049
8184
reversed again (which is not the right thing to do, but kept to not break any
8050
8185
existing configuration setting).
8051
8186
8052
3.272. sort_browser
8187
3.272. sort_browser
8053
8188
8054
Type: sort order
8055
Default: alpha
8189
Type: sort order
8190
Default: alpha
8056
8191
8057
8192
Specifies how to sort entries in the file browser. By default, the entries are
8058
8193
sorted alphabetically. Valid values:
8066
8201
You may optionally use the reverse- prefix to specify reverse sorting order
8067
8202
(example: set sort_browser=reverse-date).
8068
8203
8069
3.273. sort_re
8204
3.273. sort_re
8070
8205
8071
Type: boolean
8072
Default: yes
8206
Type: boolean
8207
Default: yes
8073
8208
8074
8209
This variable is only useful when sorting by threads with ``$strict_threads''
8075
8210
unset. In that case, it changes the heuristic mutt uses to thread messages by
8079
8214
will attach the message whether or not this is the case, as long as the non-``
8080
8215
$reply_regexp'' parts of both messages are identical.
8081
8216
8082
3.274. spam_separator
8217
3.274. spam_separator
8083
8218
8084
Type: string
8085
Default: ","
8219
Type: string
8220
Default: ","
8086
8221
8087
8222
``spam_separator'' controls what happens when multiple spam headers are
8088
8223
matched: if unset, each successive header will overwrite any previous matches
8089
8224
value for the spam label. If set, each successive match will append to the
8090
8225
previous, using ``spam_separator'' as a separator.
8091
8226
8092
3.275. spoolfile
8227
3.275. spoolfile
8093
8228
8094
Type: path
8095
Default: ""
8229
Type: path
8230
Default: ""
8096
8231
8097
8232
If your spool mailbox is in a non-default place where Mutt cannot find it, you
8098
8233
can specify its location with this variable. Mutt will automatically set this
8099
8234
variable to the value of the environment variable $MAIL if it is not set.
8100
8235
8101
3.276. status_chars
8236
3.276. status_chars
8102
8237
8103
Type: string
8104
Default: "-*%A"
8238
Type: string
8239
Default: "-*%A"
8105
8240
8106
8241
Controls the characters used by the "%r" indicator in ``$status_format''. The
8107
8242
first character is used when the mailbox is unchanged. The second is used when
8113
8248
(Certain operations like composing a new mail, replying, forwarding, etc. are
8114
8249
not permitted in this mode).
8115
8250
8116
3.277. status_format
8251
3.277. status_format
8117
8252
8118
Type: string
8119
Default: "-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F?
8120
Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---"
8253
Type: string
8254
Default: "-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F?
8255
Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---"
8121
8256
8122
8257
Controls the format of the status line displayed in the index menu. This string
8123
8258
is similar to ``$index_format'', but has its own set of printf()-like
8252
8387
replace any dots in the expansion by underscores. This might be helpful with
8253
8388
IMAP folders that don't like dots in folder names.
8254
8389
8255
3.278. status_on_top
8390
3.278. status_on_top
8256
8391
8257
Type: boolean
8258
Default: no
8392
Type: boolean
8393
Default: no
8259
8394
8260
8395
Setting this variable causes the ``status bar'' to be displayed on the first
8261
8396
line of the screen rather than near the bottom.
8262
8397
8263
3.279. strict_threads
8398
3.279. strict_threads
8264
8399
8265
Type: boolean
8266
Default: no
8400
Type: boolean
8401
Default: no
8267
8402
8268
8403
If set, threading will only make use of the ``In-Reply-To'' and ``References''
8269
8404
fields when you ``$sort'' by message threads. By default, messages with the
8272
8407
unrelated messages with the subject ``hi'' which will get grouped together. See
8273
8408
also ``$sort_re'' for a less drastic way of controlling this behaviour.
8274
8409
8275
3.280. suspend
8410
3.280. suspend
8276
8411
8277
Type: boolean
8278
Default: yes
8412
Type: boolean
8413
Default: yes
8279
8414
8280
8415
When unset, mutt won't stop when the user presses the terminal's susp key,
8281
8416
usually ``control-Z''. This is useful if you run mutt inside an xterm using a
8282
8417
command like xterm -e mutt.
8283
8418
8284
3.281. text_flowed
8419
3.281. text_flowed
8285
8420
8286
Type: boolean
8287
Default: no
8421
Type: boolean
8422
Default: no
8288
8423
8289
8424
When set, mutt will generate text/plain; format=flowed attachments. This format
8290
8425
is easier to handle for some mailing software, and generally just looks like
8293
8428
8294
8429
Note that $indent_string is ignored when this option is set.
8295
8430
8296
3.282. thread_received
8431
3.282. thread_received
8297
8432
8298
Type: boolean
8299
Default: no
8433
Type: boolean
8434
Default: no
8300
8435
8301
8436
When set, mutt uses the date received rather than the date sent to thread
8302
8437
messages by subject.
8303
8438
8304
3.283. thorough_search
8305
8306
Type: boolean
8307
Default: no
8308
8309
Affects the ˜b and ˜h search operations described in section ``patterns''
8439
3.283. thorough_search
8440
8441
Type: boolean
8442
Default: no
8443
8444
Affects the ~b and ~h search operations described in section ``patterns''
8310
8445
above. If set, the headers and attachments of messages to be searched are
8311
8446
decoded before searching. If unset, messages are searched as they appear in the
8312
8447
folder.
8313
8448
8314
3.284. tilde
8449
3.284. tilde
8315
8450
8316
Type: boolean
8317
Default: no
8451
Type: boolean
8452
Default: no
8318
8453
8319
8454
When set, the internal-pager will pad blank lines to the bottom of the screen
8320
with a tilde (˜).
8321
8322
3.285. timeout
8323
8324
Type: number
8325
Default: 600
8326
8327
This variable controls the number of seconds Mutt will wait for a key to be
8328
pressed in the main menu before timing out and checking for new mail. A value
8329
of zero or less will cause Mutt to never time out.
8330
8331
3.286. tmpdir
8332
8333
Type: path
8334
Default: ""
8455
with a tilde (~).
8456
8457
3.285. time_inc
8458
8459
Type: number
8460
Default: 0
8461
8462
Along with ``read_inc'', ``write_inc'', and ``net_inc'', this variable controls
8463
the frequency with which progress updates are displayed. It suppresses updates
8464
less than ``time_inc'' milliseconds apart. This can improve throughput on
8465
systems with slow terminals, or when running mutt on a remote system.
8466
8467
3.286. timeout
8468
8469
Type: number
8470
Default: 600
8471
8472
When Mutt is waiting for user input either idleing in menus or in an
8473
interactive prompt, Mutt would block until input is present. Depending on the
8474
context, this would prevent certain operations from working, like checking for
8475
new mail or keeping an IMAP connection alive.
8476
8477
This variable controls how many seconds Mutt will at most wait until it aborts
8478
waiting for input, performs these operations and continues to wait for input.
8479
8480
A value of zero or less will cause Mutt to never time out.
8481
8482
3.287. tmpdir
8483
8484
Type: path
8485
Default: ""
8335
8486
8336
8487
This variable allows you to specify where Mutt will place its temporary files
8337
8488
needed for displaying and composing messages. If this variable is not set, the
8338
8489
environment variable TMPDIR is used. If TMPDIR is not set then "/tmp" is used.
8339
8490
8340
3.287. to_chars
8491
3.288. to_chars
8341
8492
8342
Type: string
8343
Default: " +TCFL"
8493
Type: string
8494
Default: " +TCFL"
8344
8495
8345
8496
Controls the character used to indicate mail addressed to you. The first
8346
8497
character is the one used when the mail is NOT addressed to your address
8352
8503
mail that was sent by you. The sixth character is used to indicate when a mail
8353
8504
was sent to a mailing-list you subscribe to (default: L).
8354
8505
8355
3.288. tunnel
8506
3.289. tunnel
8356
8507
8357
Type: string
8358
Default: ""
8508
Type: string
8509
Default: ""
8359
8510
8360
8511
Setting this variable will cause mutt to open a pipe to a command instead of a
8361
8512
raw socket. You may be able to use this to set up preauthenticated connections
8366
8517
NOTE: For this example to work you must be able to log in to the remote machine
8367
8518
without having to enter a password.
8368
8519
8369
3.289. use_8bitmime
8520
3.290. use_8bitmime
8370
8521
8371
Type: boolean
8372
Default: no
8522
Type: boolean
8523
Default: no
8373
8524
8374
8525
Warning: do not set this variable unless you are using a version of sendmail
8375
8526
which supports the -B8BITMIME flag (such as sendmail 8.8.x) or you may not be
8378
8529
When set, Mutt will invoke ``$sendmail'' with the -B8BITMIME flag when sending
8379
8530
8-bit messages to enable ESMTP negotiation.
8380
8531
8381
3.290. use_domain
8532
3.291. use_domain
8382
8533
8383
Type: boolean
8384
Default: yes
8534
Type: boolean
8535
Default: yes
8385
8536
8386
8537
When set, Mutt will qualify all local addresses (ones without the @host
8387
8538
portion) with the value of ``$hostname''. If unset, no addresses will be
8388
8539
qualified.
8389
8540
8390
3.291. use_envelope_from
8541
3.292. use_envelope_from
8391
8542
8392
Type: boolean
8393
Default: no
8543
Type: boolean
8544
Default: no
8394
8545
8395
8546
When set, mutt will set the envelope sender of the message. If ``
8396
8547
$envelope_from_address'' is set, it will be used as the sender address. If not,
8401
8552
variable already contains "-f" or if the executable pointed to by $sendmail
8402
8553
doesn't support the "-f" switch.
8403
8554
8404
3.292. use_from
8555
3.293. use_from
8405
8556
8406
Type: boolean
8407
Default: yes
8557
Type: boolean
8558
Default: yes
8408
8559
8409
8560
When set, Mutt will generate the `From:' header field when sending messages. If
8410
8561
unset, no `From:' header field will be generated unless the user explicitly
8411
8562
sets one using the ``my_hdr'' command.
8412
8563
8413
3.293. use_idn
8564
3.294. use_idn
8414
8565
8415
Type: boolean
8416
Default: yes
8566
Type: boolean
8567
Default: yes
8417
8568
8418
8569
When set, Mutt will show you international domain names decoded. Note: You can
8419
8570
use IDNs for addresses even if this is unset. This variable only affects
8420
8571
decoding.
8421
8572
8422
3.294. use_ipv6
8573
3.295. use_ipv6
8423
8574
8424
Type: boolean
8425
Default: yes
8575
Type: boolean
8576
Default: yes
8426
8577
8427
8578
When set, Mutt will look for IPv6 addresses of hosts it tries to contact. If
8428
8579
this option is unset, Mutt will restrict itself to IPv4 addresses. Normally,
8429
8580
the default should work.
8430
8581
8431
3.295. user_agent
8582
3.296. user_agent
8432
8583
8433
Type: boolean
8434
Default: yes
8584
Type: boolean
8585
Default: yes
8435
8586
8436
8587
When set, mutt will add a "User-Agent" header to outgoing messages, indicating
8437
8588
which version of mutt was used for composing them.
8438
8589
8439
3.296. visual
8440
8441
Type: path
8442
Default: ""
8443
8444
Specifies the visual editor to invoke when the ˜v command is given in the
8590
3.297. visual
8591
8592
Type: path
8593
Default: ""
8594
8595
Specifies the visual editor to invoke when the ~v command is given in the
8445
8596
builtin editor.
8446
8597
8447
3.297. wait_key
8598
3.298. wait_key
8448
8599
8449
Type: boolean
8450
Default: yes
8600
Type: boolean
8601
Default: yes
8451
8602
8452
8603
Controls whether Mutt will ask you to press a key after shell- escape,
8453
8604
pipe-message, pipe-entry, print-message, and print-entry commands.
8459
8610
When set, Mutt will always ask for a key. When unset, Mutt will wait for a key
8460
8611
only if the external command returned a non-zero status.
8461
8612
8462
3.298. weed
8613
3.299. weed
8463
8614
8464
Type: boolean
8465
Default: yes
8615
Type: boolean
8616
Default: yes
8466
8617
8467
8618
When set, mutt will weed headers when displaying, forwarding, printing, or
8468
8619
replying to messages.
8469
8620
8470
3.299. wrap
8621
3.300. wrap
8471
8622
8472
Type: number
8473
Default: 0
8623
Type: number
8624
Default: 0
8474
8625
8475
8626
When set to a positive value, mutt will wrap text at $wrap characters. When set
8476
8627
to a negative value, mutt will wrap text so that there are $wrap characters of
8477
8628
empty space on the right side of the terminal.
8478
8629
8479
3.300. wrap_search
8630
3.301. wrap_search
8480
8631
8481
Type: boolean
8482
Default: yes
8632
Type: boolean
8633
Default: yes
8483
8634
8484
8635
Controls whether searches wrap around the end of the mailbox.
8485
8636
8486
8637
When set, searches will wrap around the first (or last) message. When unset,
8487
8638
searches will not wrap.
8488
8639
8489
3.301. wrapmargin
8640
3.302. wrapmargin
8490
8641
8491
Type: number
8492
Default: 0
8642
Type: number
8643
Default: 0
8493
8644
8494
8645
(DEPRECATED) Equivalent to setting wrap with a negative value.
8495
8646
8496
3.302. write_inc
8647
3.303. write_inc
8497
8648
8498
Type: number
8499
Default: 10
8649
Type: number
8650
Default: 10
8500
8651
8501
8652
When writing a mailbox, a message will be printed every write_inc messages to
8502
8653
indicate progress. If set to 0, only a single message will be displayed before
8504
8655
8505
8656
Also see the ``$read_inc'' variable.
8506
8657
8507
3.303. write_bcc
8658
3.304. write_bcc
8508
8659
8509
Type: boolean
8510
Default: yes
8660
Type: boolean
8661
Default: yes
8511
8662
8512
8663
Controls whether mutt writes out the Bcc header when preparing messages to be
8513
8664
sent. Exim users may wish to unset this. If mutt is set to deliver directly via
8514
8665
SMTP (see ``$smtp_url''), this option does nothing: mutt will never write out
8515
8666
the BCC header in this case.
8516
8667
8517
4. Functions
8668
4. Functions
8518
8669
8519
8670
The following is the list of available functions listed by the mapping in which
8520
8671
they are available. The default key setting is given, and an explanation of
8521
8672
what the function does. The key bindings of these functions can be changed with
8522
8673
the bind command.
8523
8674
8524
4.1. generic
8675
4.1. generic
8525
8676
8526
8677
The generic menu is not a real menu, but specifies common functions (such as
8527
8678
movement) available in all menus except for pager and editor. Changing settings
8528
8679
for this menu will affect the default bindings for all menus (except as noted).
8529
8680
8530
Table 8.2. Default generic function bindings
8681
Table 8.2. Default generic function bindings
8531
8682
8532
8683
┌───────────────┬───────────┬───────────────────────────────────────────┐
8533
8684
│ Function │Default key│ Description │
8598
8749
└───────────────┴───────────┴───────────────────────────────────────────┘
8599
8750
8600
8751
8601
4.2. index
8752
4.2. index
8602
8753
8603
Table 8.3. Default index function bindings
8754
Table 8.3. Default index function bindings
8604
8755
8605
8756
┌────────────────────────┬─────────┬──────────────────────────────────────────┐
8606
8757
│ Function │ Default │ Description │
8764
8915
└────────────────────────┴─────────┴──────────────────────────────────────────┘
8765
8916
8766
8917
8767
4.3. pager
8918
4.3. pager
8768
8919
8769
Table 8.4. Default pager function bindings
8920
Table 8.4. Default pager function bindings
8770
8921
8771
8922
┌──────────────────────┬─────────┬────────────────────────────────────────────┐
8772
8923
│ Function │ Default │ Description │
8937
9088
└──────────────────────┴─────────┴────────────────────────────────────────────┘
8938
9089
8939
9090
8940
4.4. alias
9091
4.4. alias
8941
9092
8942
Table 8.5. Default alias function bindings
9093
Table 8.5. Default alias function bindings
8943
9094
8944
9095
┌──────────────┬───────────┬──────────────────────────┐
8945
9096
│ Function │Default key│ Description │
8950
9101
└──────────────┴───────────┴──────────────────────────┘
8951
9102
8952
9103
8953
4.5. query
9104
4.5. query
8954
9105
8955
Table 8.6. Default query function bindings
9106
Table 8.6. Default query function bindings
8956
9107
8957
9108
┌────────────┬───────────┬───────────────────────────────────────────┐
8958
9109
│ Function │Default key│ Description │
8967
9118
└────────────┴───────────┴───────────────────────────────────────────┘
8968
9119
8969
9120
8970
4.6. attach
9121
4.6. attach
8971
9122
8972
Table 8.7. Default attach function bindings
9123
Table 8.7. Default attach function bindings
8973
9124
8974
9125
┌─────────────────────┬──────────┬────────────────────────────────────────────┐
8975
9126
│ Function │ Default │ Description │
9019
9170
└─────────────────────┴──────────┴────────────────────────────────────────────┘
9020
9171
9021
9172
9022
4.7. compose
9173
4.7. compose
9023
9174
9024
Table 8.8. Default compose function bindings
9175
Table 8.8. Default compose function bindings
9025
9176
9026
9177
┌───────────────────┬──────────┬──────────────────────────────────────────────┐
9027
9178
│ Function │ Default │ Description │
9109
9260
└───────────────────┴──────────┴──────────────────────────────────────────────┘
9110
9261
9111
9262
9112
4.8. postpone
9263
4.8. postpone
9113
9264
9114
Table 8.9. Default postpone function bindings
9265
Table 8.9. Default postpone function bindings
9115
9266
9116
9267
┌──────────────┬───────────┬──────────────────────────┐
9117
9268
│ Function │Default key│ Description │
9122
9273
└──────────────┴───────────┴──────────────────────────┘
9123
9274
9124
9275
9125
4.9. browser
9276
4.9. browser
9126
9277
9127
Table 8.10. Default browser function bindings
9278
Table 8.10. Default browser function bindings
9128
9279
9129
9280
┌─────────────────┬───────────┬───────────────────────────────────────────────┐
9130
9281
│ Function │Default key│ Description │
9164
9315
└─────────────────┴───────────┴───────────────────────────────────────────────┘
9165
9316
9166
9317
9167
4.10. pgp
9168
9169
Table 8.11. Default pgp function bindings
9170
9171
┌──────────┬───────────┬───────────────────────┐
9172
│ Function │Default key│ Description │
9173
├──────────┼───────────┼───────────────────────┤
9174
│verify-key│c │verify a PGP public key│
9175
├──────────┼───────────┼───────────────────────┤
9176
│view-name │% │view the key's user id │
9177
└──────────┴───────────┴───────────────────────┘
9178
9179
9180
4.11. smime
9181
9182
Table 8.12. Default smime function bindings
9183
9184
┌──────────┬───────────┬───────────────────────┐
9185
│ Function │Default key│ Description │
9186
├──────────┼───────────┼───────────────────────┤
9187
│verify-key│c │verify a PGP public key│
9188
├──────────┼───────────┼───────────────────────┤
9189
│view-name │% │view the key's user id │
9190
└──────────┴───────────┴───────────────────────┘
9191
9192
9193
4.12. mix
9194
9195
Table 8.13. Default mix function bindings
9318
4.10. pgp
9319
9320
Table 8.11. Default pgp function bindings
9321
9322
┌──────────┬───────────┬───────────────────────┐
9323
│ Function │Default key│ Description │
9324
├──────────┼───────────┼───────────────────────┤
9325
│verify-key│c │verify a PGP public key│
9326
├──────────┼───────────┼───────────────────────┤
9327
│view-name │% │view the key's user id │
9328
└──────────┴───────────┴───────────────────────┘
9329
9330
9331
4.11. smime
9332
9333
Table 8.12. Default smime function bindings
9334
9335
┌──────────┬───────────┬───────────────────────┐
9336
│ Function │Default key│ Description │
9337
├──────────┼───────────┼───────────────────────┤
9338
│verify-key│c │verify a PGP public key│
9339
├──────────┼───────────┼───────────────────────┤
9340
│view-name │% │view the key's user id │
9341
└──────────┴───────────┴───────────────────────┘
9342
9343
9344
4.12. mix
9345
9346
Table 8.13. Default mix function bindings
9196
9347
9197
9348
┌──────────┬───────────┬────────────────────────────────────────┐
9198
9349
│ Function │Default key│ Description │
9211
9362
└──────────┴───────────┴────────────────────────────────────────┘
9212
9363
9213
9364
9214
4.13. editor
9365
4.13. editor
9215
9366
9216
Table 8.14. Default editor function bindings
9367
Table 8.14. Default editor function bindings
9217
9368
9218
9369
┌───────────────┬───────────┬─────────────────────────────────────────────────┐
9219
9370
│ Function │Default key│ Description │
9265
9416
└───────────────┴───────────┴─────────────────────────────────────────────────┘
9266
9417
9267
9418
9268
Chapter 9. Miscellany
9419
Chapter 9. Miscellany
9269
9420
9270
9421
Table of Contents
9271
9422
9272
9423
1. Acknowledgements
9273
9424
2. About this document
9274
9425
9275
1. Acknowledgements
9426
1. Acknowledgements
9276
9427
9277
9428
Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME parsing code
9278
9429
back in the ELM-ME days.
9321
9472
Vsevolod Volkov <vvv@lucky.net>,
9322
9473
Ken Weinert <kenw@ihs.com>
9323
9474
9324
2. About this document
9475
2. About this document
9325
9476
9326
9477
This document was written in DocBook, and then rendered using the Gnome XSLT
9327
9478
toolkit.
Loggerhead is a web-based interface for Breezy
Version: 2.0.1