« back to all changes in this revision
Viewing changes to doc/manual.txt
- browse files at revision 1.1.10
- compare with another revision
- download diff
- download tarball
- view history from revision 1.1.10
- Committer: Bazaar Package Importer
- Author(s): Bhavani Shankar
- Date: 2009-06-07 17:30:03 UTC
- mto: (16.2.1 experimental) (2.3.1 squeeze)
- mto: This revision was merged to the branch mainline in revision 21.
- Revision ID: james.westby@ubuntu.com-20090607173003-rg37ui3h2bbv7wl0
Tags: upstream-1.5.19
Import upstream version 1.5.19
- files added:
- doc/mutt.css
- files removed:
- ChangeLog.old
- files modified:
- COPYRIGHT
added
removed
doc/manual.txt
1
1
The Mutt E-Mail Client
2
2
3
MichaelElkins
3
Michael Elkins
4
4
5
5
<me@cs.hmc.edu>
6
6
7
version 1.5.18 (2008-05-17)
7
version 1.5.19 (2009-01-05)
8
8
9
9
Abstract
10
10
11
``All mail clients suck. This one just sucks less.'' -me, circa 1995
11
?All mail clients suck. This one just sucks less.? -me, circa 1995
12
12
13
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
13
-------------------------------------------------------------------------------
14
14
15
15
Table of Contents
16
16
19
19
1. Mutt Home Page
20
20
2. Mailing Lists
21
21
3. Software Distribution Sites
22
4. IRC
23
5. USENET
24
6. Copyright
22
4. Mutt online resources
23
5. Contributing to Mutt
24
6. Typograhical conventions
25
7. Copyright
25
26
26
27
2. Getting Started
27
28
28
1. Moving Around in Menus
29
2. Editing Input Fields
30
31
2.1. Introduction
32
2.2. History
33
34
3. Reading Mail - The Index and Pager
35
36
3.1. The Message Index
37
3.2. The Pager
38
3.3. Threaded Mode
39
3.4. Miscellaneous Functions
40
41
4. Sending Mail
42
43
4.1. Editing the message header
44
4.2. Using Mutt with PGP
45
4.3. Sending anonymous messages via mixmaster.
46
4.4. Sending format=flowed messages
47
48
5. Forwarding and Bouncing Mail
49
6. Postponing Mail
29
1. Core concepts
30
2. Moving Around in Menus
31
3. Editing Input Fields
32
33
3.1. Introduction
34
3.2. History
35
36
4. Reading Mail - The Index and Pager
37
38
4.1. The Message Index
39
4.2. The Pager
40
4.3. Threaded Mode
41
4.4. Miscellaneous Functions
42
43
5. Sending Mail
44
45
5.1. Introduction
46
5.2. Editing the message header
47
5.3. Sending cryptographically signed/encrypted messages
48
5.4. Sending anonymous messages via mixmaster
49
5.5. Sending format=flowed messages
50
51
6. Forwarding and Bouncing Mail
52
7. Postponing Mail
50
53
51
54
3. Configuration
52
55
53
1. Syntax of Initialization Files
54
2. Address groups
55
3. Defining/Using aliases
56
4. Changing the default key bindings
57
5. Defining aliases for character sets
58
6. Setting variables based upon mailbox
59
7. Keyboard macros
60
8. Using color and mono video attributes
61
9. Ignoring (weeding) unwanted message headers
62
10. Alternative addresses
63
11. Mailing lists
64
12. Using Multiple spool mailboxes
65
13. Monitoring incoming mail
66
14. User defined headers
67
15. Defining the order of headers when viewing messages
56
1. Location of initialization files
57
2. Syntax of Initialization Files
58
3. Address groups
59
4. Defining/Using aliases
60
5. Changing the default key bindings
61
6. Defining aliases for character sets
62
7. Setting variables based upon mailbox
63
8. Keyboard macros
64
9. Using color and mono video attributes
65
10. Message header display
66
11. Alternative addresses
67
12. Mailing lists
68
13. Using Multiple spool mailboxes
69
14. Monitoring incoming mail
70
15. User defined headers
68
71
16. Specify default save mailbox
69
72
17. Specify default Fcc: mailbox when composing
70
73
18. Specify default save filename and default Fcc: mailbox at once
106
109
6. Mailbox Formats
107
110
7. Mailbox Shortcuts
108
111
8. Handling Mailing Lists
109
9. Editing threads
110
111
9.1. Linking threads
112
9.2. Breaking threads
113
114
10. Delivery Status Notification (DSN) Support
115
11. Start a WWW Browser on URLs (EXTERNAL)
112
9. Handling multiple folders
113
10. Editing threads
114
115
10.1. Linking threads
116
10.2. Breaking threads
117
118
11. Delivery Status Notification (DSN) Support
119
12. Start a WWW Browser on URLs
116
120
117
121
5. Mutt's MIME Support
118
122
264
268
3.91. imap_pass
265
269
3.92. imap_passive
266
270
3.93. imap_peek
267
3.94. imap_servernoise
268
3.95. imap_user
269
3.96. implicit_autoview
270
3.97. include
271
3.98. include_onlyfirst
272
3.99. indent_string
273
3.100. index_format
274
3.101. ispell
275
3.102. keep_flagged
276
3.103. locale
277
3.104. mail_check
278
3.105. mailcap_path
279
3.106. mailcap_sanitize
280
3.107. header_cache
281
3.108. maildir_header_cache_verify
282
3.109. header_cache_pagesize
283
3.110. header_cache_compress
284
3.111. maildir_trash
285
3.112. mark_old
286
3.113. markers
287
3.114. mask
288
3.115. mbox
289
3.116. mbox_type
290
3.117. metoo
291
3.118. menu_context
292
3.119. menu_move_off
293
3.120. menu_scroll
294
3.121. meta_key
295
3.122. mh_purge
296
3.123. mh_seq_flagged
297
3.124. mh_seq_replied
298
3.125. mh_seq_unseen
299
3.126. mime_forward
300
3.127. mime_forward_decode
301
3.128. mime_forward_rest
302
3.129. mix_entry_format
303
3.130. mixmaster
304
3.131. move
305
3.132. message_cachedir
306
3.133. message_cache_clean
307
3.134. message_format
308
3.135. narrow_tree
309
3.136. net_inc
310
3.137. pager
311
3.138. pager_context
312
3.139. pager_format
313
3.140. pager_index_lines
314
3.141. pager_stop
315
3.142. crypt_autosign
316
3.143. crypt_autoencrypt
317
3.144. pgp_ignore_subkeys
318
3.145. crypt_replyencrypt
319
3.146. crypt_replysign
320
3.147. crypt_replysignencrypted
321
3.148. crypt_timestamp
322
3.149. pgp_use_gpg_agent
323
3.150. crypt_verify_sig
324
3.151. smime_is_default
325
3.152. smime_ask_cert_label
326
3.153. smime_decrypt_use_default_key
327
3.154. pgp_entry_format
328
3.155. pgp_good_sign
329
3.156. pgp_check_exit
330
3.157. pgp_long_ids
331
3.158. pgp_retainable_sigs
332
3.159. pgp_autoinline
333
3.160. pgp_replyinline
334
3.161. pgp_show_unusable
335
3.162. pgp_sign_as
336
3.163. pgp_strict_enc
337
3.164. pgp_timeout
338
3.165. pgp_sort_keys
339
3.166. pgp_mime_auto
340
3.167. pgp_auto_decode
341
3.168. pgp_decode_command
342
3.169. pgp_getkeys_command
343
3.170. pgp_verify_command
344
3.171. pgp_decrypt_command
345
3.172. pgp_clearsign_command
346
3.173. pgp_sign_command
347
3.174. pgp_encrypt_sign_command
348
3.175. pgp_encrypt_only_command
349
3.176. pgp_import_command
350
3.177. pgp_export_command
351
3.178. pgp_verify_key_command
352
3.179. pgp_list_secring_command
353
3.180. pgp_list_pubring_command
354
3.181. forward_decrypt
355
3.182. smime_timeout
356
3.183. smime_encrypt_with
357
3.184. smime_keys
358
3.185. smime_ca_location
359
3.186. smime_certificates
360
3.187. smime_decrypt_command
361
3.188. smime_verify_command
362
3.189. smime_verify_opaque_command
363
3.190. smime_sign_command
364
3.191. smime_sign_opaque_command
365
3.192. smime_encrypt_command
366
3.193. smime_pk7out_command
367
3.194. smime_get_cert_command
368
3.195. smime_get_signer_cert_command
369
3.196. smime_import_cert_command
370
3.197. smime_get_cert_email_command
371
3.198. smime_default_key
372
3.199. ssl_client_cert
373
3.200. ssl_force_tls
374
3.201. ssl_starttls
375
3.202. certificate_file
376
3.203. ssl_usesystemcerts
377
3.204. entropy_file
378
3.205. ssl_use_sslv2
379
3.206. ssl_use_sslv3
380
3.207. ssl_use_tlsv1
381
3.208. ssl_min_dh_prime_bits
382
3.209. ssl_ca_certificates_file
383
3.210. pipe_split
384
3.211. pipe_decode
385
3.212. pipe_sep
386
3.213. pop_authenticators
387
3.214. pop_auth_try_all
388
3.215. pop_checkinterval
389
3.216. pop_delete
390
3.217. pop_host
391
3.218. pop_last
392
3.219. pop_reconnect
393
3.220. pop_user
394
3.221. pop_pass
395
3.222. post_indent_string
396
3.223. postpone
397
3.224. postponed
398
3.225. preconnect
399
3.226. print
400
3.227. print_command
401
3.228. print_decode
402
3.229. print_split
403
3.230. prompt_after
404
3.231. query_command
405
3.232. query_format
406
3.233. quit
407
3.234. quote_regexp
408
3.235. read_inc
409
3.236. read_only
410
3.237. realname
411
3.238. recall
412
3.239. record
413
3.240. reply_regexp
414
3.241. reply_self
415
3.242. reply_to
416
3.243. resolve
417
3.244. reverse_alias
418
3.245. reverse_name
419
3.246. reverse_realname
420
3.247. rfc2047_parameters
421
3.248. save_address
422
3.249. save_empty
423
3.250. save_history
424
3.251. save_name
425
3.252. score
426
3.253. score_threshold_delete
427
3.254. score_threshold_flag
428
3.255. score_threshold_read
429
3.256. send_charset
430
3.257. sendmail
431
3.258. sendmail_wait
432
3.259. shell
433
3.260. sig_dashes
434
3.261. sig_on_top
435
3.262. signature
436
3.263. simple_search
437
3.264. smart_wrap
438
3.265. smileys
439
3.266. sleep_time
440
3.267. smtp_authenticators
441
3.268. smtp_pass
442
3.269. smtp_url
443
3.270. sort
444
3.271. sort_alias
445
3.272. sort_aux
446
3.273. sort_browser
447
3.274. sort_re
448
3.275. spam_separator
449
3.276. spoolfile
450
3.277. status_chars
451
3.278. status_format
452
3.279. status_on_top
453
3.280. strict_threads
454
3.281. suspend
455
3.282. text_flowed
456
3.283. thread_received
457
3.284. thorough_search
458
3.285. tilde
459
3.286. time_inc
460
3.287. timeout
461
3.288. tmpdir
462
3.289. to_chars
463
3.290. tunnel
464
3.291. use_8bitmime
465
3.292. use_domain
466
3.293. use_envelope_from
467
3.294. use_from
468
3.295. use_idn
469
3.296. use_ipv6
470
3.297. user_agent
471
3.298. visual
472
3.299. wait_key
473
3.300. weed
474
3.301. wrap
475
3.302. wrap_search
476
3.303. wrapmargin
477
3.304. write_inc
478
3.305. write_bcc
271
3.94. imap_pipeline_depth
272
3.95. imap_servernoise
273
3.96. imap_user
274
3.97. implicit_autoview
275
3.98. include
276
3.99. include_onlyfirst
277
3.100. indent_string
278
3.101. index_format
279
3.102. ispell
280
3.103. keep_flagged
281
3.104. locale
282
3.105. mail_check
283
3.106. mailcap_path
284
3.107. mailcap_sanitize
285
3.108. header_cache
286
3.109. maildir_header_cache_verify
287
3.110. header_cache_pagesize
288
3.111. header_cache_compress
289
3.112. maildir_trash
290
3.113. mark_old
291
3.114. markers
292
3.115. mask
293
3.116. mbox
294
3.117. mbox_type
295
3.118. metoo
296
3.119. menu_context
297
3.120. menu_move_off
298
3.121. menu_scroll
299
3.122. meta_key
300
3.123. mh_purge
301
3.124. mh_seq_flagged
302
3.125. mh_seq_replied
303
3.126. mh_seq_unseen
304
3.127. mime_forward
305
3.128. mime_forward_decode
306
3.129. mime_forward_rest
307
3.130. mix_entry_format
308
3.131. mixmaster
309
3.132. move
310
3.133. message_cachedir
311
3.134. message_cache_clean
312
3.135. message_format
313
3.136. narrow_tree
314
3.137. net_inc
315
3.138. pager
316
3.139. pager_context
317
3.140. pager_format
318
3.141. pager_index_lines
319
3.142. pager_stop
320
3.143. crypt_autosign
321
3.144. crypt_autoencrypt
322
3.145. pgp_ignore_subkeys
323
3.146. crypt_replyencrypt
324
3.147. crypt_replysign
325
3.148. crypt_replysignencrypted
326
3.149. crypt_timestamp
327
3.150. pgp_use_gpg_agent
328
3.151. crypt_verify_sig
329
3.152. smime_is_default
330
3.153. smime_ask_cert_label
331
3.154. smime_decrypt_use_default_key
332
3.155. pgp_entry_format
333
3.156. pgp_good_sign
334
3.157. pgp_check_exit
335
3.158. pgp_long_ids
336
3.159. pgp_retainable_sigs
337
3.160. pgp_autoinline
338
3.161. pgp_replyinline
339
3.162. pgp_show_unusable
340
3.163. pgp_sign_as
341
3.164. pgp_strict_enc
342
3.165. pgp_timeout
343
3.166. pgp_sort_keys
344
3.167. pgp_mime_auto
345
3.168. pgp_auto_decode
346
3.169. pgp_decode_command
347
3.170. pgp_getkeys_command
348
3.171. pgp_verify_command
349
3.172. pgp_decrypt_command
350
3.173. pgp_clearsign_command
351
3.174. pgp_sign_command
352
3.175. pgp_encrypt_sign_command
353
3.176. pgp_encrypt_only_command
354
3.177. pgp_import_command
355
3.178. pgp_export_command
356
3.179. pgp_verify_key_command
357
3.180. pgp_list_secring_command
358
3.181. pgp_list_pubring_command
359
3.182. forward_decrypt
360
3.183. smime_timeout
361
3.184. smime_encrypt_with
362
3.185. smime_keys
363
3.186. smime_ca_location
364
3.187. smime_certificates
365
3.188. smime_decrypt_command
366
3.189. smime_verify_command
367
3.190. smime_verify_opaque_command
368
3.191. smime_sign_command
369
3.192. smime_sign_opaque_command
370
3.193. smime_encrypt_command
371
3.194. smime_pk7out_command
372
3.195. smime_get_cert_command
373
3.196. smime_get_signer_cert_command
374
3.197. smime_import_cert_command
375
3.198. smime_get_cert_email_command
376
3.199. smime_default_key
377
3.200. ssl_client_cert
378
3.201. ssl_force_tls
379
3.202. ssl_starttls
380
3.203. certificate_file
381
3.204. ssl_usesystemcerts
382
3.205. entropy_file
383
3.206. ssl_use_sslv2
384
3.207. ssl_use_sslv3
385
3.208. ssl_use_tlsv1
386
3.209. ssl_min_dh_prime_bits
387
3.210. ssl_ca_certificates_file
388
3.211. pipe_split
389
3.212. pipe_decode
390
3.213. pipe_sep
391
3.214. pop_authenticators
392
3.215. pop_auth_try_all
393
3.216. pop_checkinterval
394
3.217. pop_delete
395
3.218. pop_host
396
3.219. pop_last
397
3.220. pop_reconnect
398
3.221. pop_user
399
3.222. pop_pass
400
3.223. post_indent_string
401
3.224. postpone
402
3.225. postponed
403
3.226. preconnect
404
3.227. print
405
3.228. print_command
406
3.229. print_decode
407
3.230. print_split
408
3.231. prompt_after
409
3.232. query_command
410
3.233. query_format
411
3.234. quit
412
3.235. quote_regexp
413
3.236. read_inc
414
3.237. read_only
415
3.238. realname
416
3.239. recall
417
3.240. record
418
3.241. reply_regexp
419
3.242. reply_self
420
3.243. reply_to
421
3.244. resolve
422
3.245. reverse_alias
423
3.246. reverse_name
424
3.247. reverse_realname
425
3.248. rfc2047_parameters
426
3.249. save_address
427
3.250. save_empty
428
3.251. save_history
429
3.252. save_name
430
3.253. score
431
3.254. score_threshold_delete
432
3.255. score_threshold_flag
433
3.256. score_threshold_read
434
3.257. send_charset
435
3.258. sendmail
436
3.259. sendmail_wait
437
3.260. shell
438
3.261. sig_dashes
439
3.262. sig_on_top
440
3.263. signature
441
3.264. simple_search
442
3.265. smart_wrap
443
3.266. smileys
444
3.267. sleep_time
445
3.268. smtp_authenticators
446
3.269. smtp_pass
447
3.270. smtp_url
448
3.271. sort
449
3.272. sort_alias
450
3.273. sort_aux
451
3.274. sort_browser
452
3.275. sort_re
453
3.276. spam_separator
454
3.277. spoolfile
455
3.278. status_chars
456
3.279. status_format
457
3.280. status_on_top
458
3.281. strict_threads
459
3.282. suspend
460
3.283. text_flowed
461
3.284. thread_received
462
3.285. thorough_search
463
3.286. tilde
464
3.287. time_inc
465
3.288. timeout
466
3.289. tmpdir
467
3.290. to_chars
468
3.291. tunnel
469
3.292. use_8bitmime
470
3.293. use_domain
471
3.294. use_envelope_from
472
3.295. use_from
473
3.296. use_idn
474
3.297. use_ipv6
475
3.298. user_agent
476
3.299. visual
477
3.300. wait_key
478
3.301. weed
479
3.302. wrap
480
3.303. wrap_search
481
3.304. wrapmargin
482
3.305. write_inc
483
3.306. write_bcc
479
484
480
485
4. Functions
481
486
482
4.1. generic
483
4.2. index
484
4.3. pager
485
4.4. alias
486
4.5. query
487
4.6. attach
488
4.7. compose
489
4.8. postpone
490
4.9. browser
491
4.10. pgp
492
4.11. smime
493
4.12. mix
494
4.13. editor
487
4.1. generic menu
488
4.2. index menu
489
4.3. pager menu
490
4.4. alias menu
491
4.5. query menu
492
4.6. attach menu
493
4.7. compose menu
494
4.8. postpone menu
495
4.9. browser menu
496
4.10. pgp menu
497
4.11. smime menu
498
4.12. mix menu
499
4.13. editor menu
495
500
496
501
9. Miscellany
497
502
500
505
501
506
List of Tables
502
507
508
1.1. Typographical conventions for special terms
503
509
2.1. Most common navigation keys
504
510
2.2. Most common line editor keys
505
511
2.3. Most common message index keys
506
2.4. Most common pager keys
507
2.5. ANSI escape sequences
508
2.6. Color sequences
509
2.7. Most common thread mode keys
510
2.8. Most common mail sending keys
511
2.9. Most common compose menu keys
512
2.10. PGP key menu flags
513
2.11. Message forwarding/bouncing keys
512
2.4. Message status flags
513
2.5. Message recipient flags
514
2.6. Most common pager keys
515
2.7. ANSI escape sequences
516
2.8. Color sequences
517
2.9. Most common thread mode keys
518
2.10. Most common mail sending keys
519
2.11. Most common compose menu keys
520
2.12. PGP key menu flags
514
521
3.1. Symbolic key names
515
4.1. Pattern modifiers
516
4.2. Simple search keywords
517
4.3. Date units
522
4.1. POSIX regular expression character classes
523
4.2. Regular expression repetition operators
524
4.3. GNU regular expression extensions
525
4.4. Pattern modifiers
526
4.5. Simple search keywords
527
4.6. Date units
518
528
8.1. Command line options
519
529
8.2. Default generic function bindings
520
530
8.3. Default index function bindings
530
540
8.13. Default mix function bindings
531
541
8.14. Default editor function bindings
532
542
543
List of Examples
544
545
3.1. Multiple configuration commands per line
546
3.2. Commenting configuration files
547
3.3. Escaping quotes in congfiguration files
548
3.4. Using external command's output in configuration files
549
3.5. Using environment variables in configuration files
550
3.6. Configuring external alias files
551
3.7. Setting sort method based on mailbox name
552
3.8. Header weeding
553
3.9. Configuring header display order
554
3.10. Defining custom headers
555
3.11. Using %-expandos in save-hook
556
3.12. Embedding push in folder-hook
557
3.13. Configuring spam detection
558
3.14. Using user-defined variables for config file readability
559
3.15. Using user-defined variables for backing up other config option values
560
3.16. Deferring user-defined variable expansion to runtime
561
3.17. Using external filters in format strings
562
4.1. Using boolean operators in patterns
563
4.2. Combining send-hook and my_hdr
564
5.1. Attachment counting
565
533
566
Chapter 1. Introduction
534
567
535
568
Table of Contents
537
570
1. Mutt Home Page
538
571
2. Mailing Lists
539
572
3. Software Distribution Sites
540
4. IRC
541
5. USENET
542
6. Copyright
573
4. Mutt online resources
574
5. Contributing to Mutt
575
6. Typograhical conventions
576
7. Copyright
543
577
544
578
Mutt is a small but very powerful text-based MIME mail client. Mutt is highly
545
579
configurable, and is well suited to the mail power user with advanced features
548
582
549
583
1. Mutt Home Page
550
584
551
http://www.mutt.org/
585
The official homepage can be found at http://www.mutt.org/.
552
586
553
587
2. Mailing Lists
554
588
555
589
To subscribe to one of the following mailing lists, send a message with the
556
590
word subscribe in the body to list-name-request@mutt.org.
557
591
558
● <mutt-announce-request@mutt.org> -- low traffic list for announcements
559
560
● <mutt-users-request@mutt.org> -- help, bug reports and feature requests
561
562
● <mutt-dev-request@mutt.org> -- development mailing list
563
564
Note: all messages posted to mutt-announce are automatically forwarded to
565
mutt-users, so you do not need to be subscribed to both lists.
592
* <mutt-announce-request@mutt.org> -- low traffic list for announcements
593
594
* <mutt-users-request@mutt.org> -- help, bug reports and feature requests
595
596
* <mutt-dev-request@mutt.org> -- development mailing list
597
598
Note
599
600
All messages posted to mutt-announce are automatically forwarded to mutt-users,
601
so you do not need to be subscribed to both lists.
566
602
567
603
3. Software Distribution Sites
568
604
569
● ftp://ftp.mutt.org/mutt/
570
571
For a list of mirror sites, please refer to http://www.mutt.org/download.html.
572
573
4. IRC
574
575
Visit channel #mutt on irc.freenode.net to chat with other people interested in
576
Mutt.
577
578
5. USENET
579
580
See the newsgroup comp.mail.mutt.
581
582
6. Copyright
583
584
Mutt is Copyright (C) 1996-2005 Michael R. Elkins <me@cs.hmc.edu> and others
605
Mutt releases can be downloaded from ftp://ftp.mutt.org/mutt/. For a list of
606
mirror sites, please refer to http://www.mutt.org/download.html.
607
608
4. Mutt online resources
609
610
Bug Tracking System
611
612
The official mutt bug tracking system can be found at http://dev.mutt.org/
613
614
Wiki
615
616
An (unofficial) wiki can be found at http://wiki.mutt.org/.
617
618
IRC
619
620
For the IRC user community, visit channel #mutt on irc.freenode.net.
621
622
USENET
623
624
For USENET, see the newsgroup comp.mail.mutt.
625
626
5. Contributing to Mutt
627
628
There are various ways to contribute to the Mutt project.
629
630
Especially for new users it may be helpful to meet other new and experienced
631
users to chat about Mutt, talk about problems and share tricks.
632
633
Since translations of Mutt into other languages are highly appreciated, the
634
mutt developers always look for skilled translators that help improve and
635
continue to maintain stale translations.
636
637
For contributing code patches for new features and bug fixes, please refer to
638
the developer pages at http://dev.mutt.org/ for more details.
639
640
6. Typograhical conventions
641
642
This section lists typographical conventions followed throughout this manual.
643
See table Table 1.1, ?Typographical conventions for special terms? for
644
typographical conventions for special terms.
645
646
Table 1.1. Typographical conventions for special terms
647
648
+------------------------------------------------------+
649
| Item | Refers to... |
650
|--------------+---------------------------------------|
651
|printf(3) |UNIX manual pages, execute man 3 printf|
652
|--------------+---------------------------------------|
653
|<PageUp> |named keys |
654
|--------------+---------------------------------------|
655
|<create-alias>|named Mutt function |
656
|--------------+---------------------------------------|
657
|^G |Control+G key combination |
658
|--------------+---------------------------------------|
659
|$mail_check |Mutt configuration option |
660
+------------------------------------------------------+
661
662
663
Examples are presented as:
664
665
mutt -v
666
667
Within command synopsis, curly brackets (?{}?) denote a set of options of which
668
one is mandatory, square brackets (?[]?) denote optional arguments, three dots
669
denote that the argument may be repeated arbitrary times.
670
671
7. Copyright
672
673
Mutt is Copyright (C) 1996-2009 Michael R. Elkins <me@mutt.org> and others.
585
674
586
675
This program is free software; you can redistribute it and/or modify it under
587
676
the terms of the GNU General Public License as published by the Free Software
600
689
601
690
Table of Contents
602
691
603
1. Moving Around in Menus
604
2. Editing Input Fields
605
606
2.1. Introduction
607
2.2. History
608
609
3. Reading Mail - The Index and Pager
610
611
3.1. The Message Index
612
3.2. The Pager
613
3.3. Threaded Mode
614
3.4. Miscellaneous Functions
615
616
4. Sending Mail
617
618
4.1. Editing the message header
619
4.2. Using Mutt with PGP
620
4.3. Sending anonymous messages via mixmaster.
621
4.4. Sending format=flowed messages
622
623
5. Forwarding and Bouncing Mail
624
6. Postponing Mail
692
1. Core concepts
693
2. Moving Around in Menus
694
3. Editing Input Fields
695
696
3.1. Introduction
697
3.2. History
698
699
4. Reading Mail - The Index and Pager
700
701
4.1. The Message Index
702
4.2. The Pager
703
4.3. Threaded Mode
704
4.4. Miscellaneous Functions
705
706
5. Sending Mail
707
708
5.1. Introduction
709
5.2. Editing the message header
710
5.3. Sending cryptographically signed/encrypted messages
711
5.4. Sending anonymous messages via mixmaster
712
5.5. Sending format=flowed messages
713
714
6. Forwarding and Bouncing Mail
715
7. Postponing Mail
625
716
626
717
This section is intended as a brief overview of how to use Mutt. There are many
627
718
other features which are described elsewhere in the manual. There is even more
628
information available in the Mutt FAQ and various web pages. See the Mutt Page
629
for more details.
719
information available in the Mutt FAQ and various web pages. See the Mutt
720
homepage for more details.
630
721
631
722
The keybindings described in this section are the defaults as distributed. Your
632
723
local system administrator may have altered the defaults for your site. You can
633
always type ``?'' in any menu to display the current bindings.
724
always type ??? in any menu to display the current bindings.
634
725
635
726
The first thing you need to do is invoke mutt, simply by typing mutt at the
636
727
command line. There are various command-line options, see either the mutt man
637
728
page or the reference.
638
729
639
1. Moving Around in Menus
640
641
Information is presented in menus, very similar to ELM, see Table 2.1, "Most
642
common navigation keys" for common keys used to navigate menus in Mutt.
730
1. Core concepts
731
732
Mutt is a text-based application which interacts with users through different
733
menus which are mostly line-/entry-based or page-based. A line-based menu is
734
the so-called ?index? menu (listing all messages of the currently opened
735
folder) or the ?alias? menu (allowing you to select recipients from a list).
736
Examples for page-based menus are the ?pager? (showing one message at a time)
737
or the ?help? menu listing all available key bindings.
738
739
The user interface consists of a context sensitive help line at the top, the
740
menu's contents followed by a context sensitive status line and finally the
741
command line. The command line is used to display informational and error
742
messages as well as for prompts and for entering interactive commands.
743
744
Because Mutt allows for customizing almost all key bindings, there are
745
so-called ?functions? which can be executed manually (using the command line)
746
or in macros. Macros allow the user to bind a sequence of commands to a single
747
key or a short key sequence instead of repeating a sequence of actions over and
748
over.
749
750
Many commands (such as saving or copying a message to another folder) can be
751
applied to a single message or a set of messages (so-called ?tagged? messages).
752
To help selecting messages, Mutt provides a rich set of message patterns (such
753
as recipients, sender, body contents, date sent/received, etc.) which can be
754
combined into complex expressions using the boolean and and or operations as
755
well as negating. These patterns can also be used to (for example) search for
756
messages or to limit the index to show only matching messages.
757
758
Mutt supports a ?hook? concept which allows the user to execute arbitrary
759
configuration commands and functions in certain situations such as entering a
760
folder, starting a new message or replying to an existing one. These hooks can
761
be used to highly customize Mutt's behaviour including managing multiple
762
identities, customizing the display for a folder or even implementing
763
auto-archiving based on a per-folder basis and much more.
764
765
2. Moving Around in Menus
766
767
The most important navigation keys common to all menus are shown in Table 2.1,
768
?Most common navigation keys?.
643
769
644
770
Table 2.1. Most common navigation keys
645
771
646
┌───────────┬──────────────┬─────────────────────────────────────────┐
647
│ Key │ Function │ Description │
648
├───────────┼──────────────┼─────────────────────────────────────────┤
649
│j or Down │next-entry │move to the next entry │
650
├───────────┼──────────────┼─────────────────────────────────────────┤
651
│k or Up │previous-entry│move to the previous entry │
652
├───────────┼──────────────┼─────────────────────────────────────────┤
653
│z or PageDn│page-down │go to the next page │
654
├───────────┼──────────────┼─────────────────────────────────────────┤
655
│Z or PageUp│page-up │go to the previous page │
656
├───────────┼──────────────┼─────────────────────────────────────────┤
657
│= or Home │first-entry │jump to the first entry │
658
├───────────┼──────────────┼─────────────────────────────────────────┤
659
│* or End │last-entry │jump to the last entry │
660
├───────────┼──────────────┼─────────────────────────────────────────┤
661
│q │quit │exit the current menu │
662
├───────────┼──────────────┼─────────────────────────────────────────┤
663
│? │help │list all keybindings for the current menu│
664
└───────────┴──────────────┴─────────────────────────────────────────┘
665
666
667
2. Editing Input Fields
668
669
2.1. Introduction
772
+------------------------------------------------------------------------+
773
| Key | Function | Description |
774
|-------------+----------------+-----------------------------------------|
775
|j or <Down> |<next-entry> |move to the next entry |
776
|-------------+----------------+-----------------------------------------|
777
|k or <Up> |<previous-entry>|move to the previous entry |
778
|-------------+----------------+-----------------------------------------|
779
|z or <PageDn>|<page-down> |go to the next page |
780
|-------------+----------------+-----------------------------------------|
781
|Z or <PageUp>|<page-up> |go to the previous page |
782
|-------------+----------------+-----------------------------------------|
783
|= or <Home> |<first-entry> |jump to the first entry |
784
|-------------+----------------+-----------------------------------------|
785
|* or <End> |<last-entry> |jump to the last entry |
786
|-------------+----------------+-----------------------------------------|
787
|q |<quit> |exit the current menu |
788
|-------------+----------------+-----------------------------------------|
789
|? |<help> |list all keybindings for the current menu|
790
+------------------------------------------------------------------------+
791
792
793
3. Editing Input Fields
794
795
3.1. Introduction
670
796
671
797
Mutt has a built-in line editor for inputting text, e.g. email addresses or
672
798
filenames. The keys used to manipulate text input are very similar to those of
673
Emacs. See Table 2.2, "Most common line editor keys" for a full reference of
799
Emacs. See Table 2.2, ?Most common line editor keys? for a full reference of
674
800
available functions, their default key bindings, and short descriptions.
675
801
676
802
Table 2.2. Most common line editor keys
677
803
678
┌──────────────┬───────────────┬────────────────────────────────────┐
679
│ Key │ Function │ Description │
680
├──────────────┼───────────────┼────────────────────────────────────┤
681
│^A or <Home> │bol │move to the start of the line │
682
├──────────────┼───────────────┼────────────────────────────────────┤
683
│^B or <Left> │backward-char │move back one char │
684
├──────────────┼───────────────┼────────────────────────────────────┤
685
│Esc B │backward-word │move back one word │
686
├──────────────┼───────────────┼────────────────────────────────────┤
687
│^D or <Delete>│delete-char │delete the char under the cursor │
688
├──────────────┼───────────────┼────────────────────────────────────┤
689
│^E or <End> │eol │move to the end of the line │
690
├──────────────┼───────────────┼────────────────────────────────────┤
691
│^F or <Right> │forward-char │move forward one char │
692
├──────────────┼───────────────┼────────────────────────────────────┤
693
│Esc F │forward-word │move forward one word │
694
├──────────────┼───────────────┼────────────────────────────────────┤
695
│<Tab> │complete │complete filename or alias │
696
├──────────────┼───────────────┼────────────────────────────────────┤
697
│^T │complete-query │complete address with query │
698
├──────────────┼───────────────┼────────────────────────────────────┤
699
│^K │kill-eol │delete to the end of the line │
700
├──────────────┼───────────────┼────────────────────────────────────┤
701
│ESC d │kill-eow │delete to the end ot the word │
702
├──────────────┼───────────────┼────────────────────────────────────┤
703
│^W │kill-word │kill the word in front of the cursor│
704
├──────────────┼───────────────┼────────────────────────────────────┤
705
│^U │kill-line │delete entire line │
706
├──────────────┼───────────────┼────────────────────────────────────┤
707
│^V │quote-char │quote the next typed key │
708
├──────────────┼───────────────┼────────────────────────────────────┤
709
│<Up> │history-up │recall previous string from history │
710
├──────────────┼───────────────┼────────────────────────────────────┤
711
│<Down> │history-down │recall next string from history │
712
├──────────────┼───────────────┼────────────────────────────────────┤
713
│<BackSpace> │backspace │kill the char in front of the cursor│
714
├──────────────┼───────────────┼────────────────────────────────────┤
715
│Esc u │upcase-word │convert word to upper case │
716
├──────────────┼───────────────┼────────────────────────────────────┤
717
│Esc l │downcase-word │convert word to lower case │
718
├──────────────┼───────────────┼────────────────────────────────────┤
719
│Esc c │capitalize-word│capitalize the word │
720
├──────────────┼───────────────┼────────────────────────────────────┤
721
│^G │n/a │abort │
722
├──────────────┼───────────────┼────────────────────────────────────┤
723
│<Return> │n/a │finish editing │
724
└──────────────┴───────────────┴────────────────────────────────────┘
804
+---------------------------------------------------------------------+
805
| Key | Function | Description |
806
|--------------+-----------------+------------------------------------|
807
|^A or <Home> |<bol> |move to the start of the line |
808
|--------------+-----------------+------------------------------------|
809
|^B or <Left> |<backward-char> |move back one char |
810
|--------------+-----------------+------------------------------------|
811
|Esc B |<backward-word> |move back one word |
812
|--------------+-----------------+------------------------------------|
813
|^D or <Delete>|<delete-char> |delete the char under the cursor |
814
|--------------+-----------------+------------------------------------|
815
|^E or <End> |<eol> |move to the end of the line |
816
|--------------+-----------------+------------------------------------|
817
|^F or <Right> |<forward-char> |move forward one char |
818
|--------------+-----------------+------------------------------------|
819
|Esc F |<forward-word> |move forward one word |
820
|--------------+-----------------+------------------------------------|
821
|<Tab> |<complete> |complete filename or alias |
822
|--------------+-----------------+------------------------------------|
823
|^T |<complete-query> |complete address with query |
824
|--------------+-----------------+------------------------------------|
825
|^K |<kill-eol> |delete to the end of the line |
826
|--------------+-----------------+------------------------------------|
827
|Esc d |<kill-eow> |delete to the end of the word |
828
|--------------+-----------------+------------------------------------|
829
|^W |<kill-word> |kill the word in front of the cursor|
830
|--------------+-----------------+------------------------------------|
831
|^U |<kill-line> |delete entire line |
832
|--------------+-----------------+------------------------------------|
833
|^V |<quote-char> |quote the next typed key |
834
|--------------+-----------------+------------------------------------|
835
|<Up> |<history-up> |recall previous string from history |
836
|--------------+-----------------+------------------------------------|
837
|<Down> |<history-down> |recall next string from history |
838
|--------------+-----------------+------------------------------------|
839
|<BackSpace> |<backspace> |kill the char in front of the cursor|
840
|--------------+-----------------+------------------------------------|
841
|Esc u |<upcase-word> |convert word to upper case |
842
|--------------+-----------------+------------------------------------|
843
|Esc l |<downcase-word> |convert word to lower case |
844
|--------------+-----------------+------------------------------------|
845
|Esc c |<capitalize-word>|capitalize the word |
846
|--------------+-----------------+------------------------------------|
847
|^G |n/a |abort |
848
|--------------+-----------------+------------------------------------|
849
|<Return> |n/a |finish editing |
850
+---------------------------------------------------------------------+
725
851
726
852
727
853
You can remap the editor functions using the bind command. For example, to make
728
the Delete key delete the character in front of the cursor rather than under,
729
you could use
854
the <Delete> key delete the character in front of the cursor rather than under,
855
you could use:
730
856
731
857
bind editor <delete> backspace
732
858
733
2.2. History
859
3.2. History
734
860
735
The number of items in the built-in editor's history is controlled by the
736
$history variable. You may cycle through them at an editor prompt by using the
737
history-up and/or history-down commands.
861
Mutt maintains a history for the built-in editor. The number of items is
862
controlled by the $history variable and can be made persistent using an
863
external file specified using $history_file. You may cycle through them at an
864
editor prompt by using the <history-up> and/or <history-down> commands.
738
865
739
866
Mutt maintains several distinct history lists, one for each of the following
740
867
categories:
741
868
742
● muttrc commands
743
744
● addresses and aliases
745
746
● shell commands
747
748
● filenames
749
750
● patterns
751
752
● everything else
869
* muttrc commands
870
871
* addresses and aliases
872
873
* shell commands
874
875
* filenames
876
877
* patterns
878
879
* everything else
753
880
754
881
Mutt automatically filters out repeated items from the history. It also mimics
755
the behavior of some shells by ignoring items starting with a space.
756
757
The latter feature can be useful in macros to not clobber the history's
758
valuable entries with unwanted entries.
759
760
3. Reading Mail - The Index and Pager
882
the behavior of some shells by ignoring items starting with a space. The latter
883
feature can be useful in macros to not clobber the history's valuable entries
884
with unwanted entries.
885
886
4. Reading Mail - The Index and Pager
761
887
762
888
Similar to many other mail clients, there are two modes in which mail is read
763
889
in Mutt. The first is the index of messages in the mailbox, which is called the
764
``index'' in Mutt. The second mode is the display of the message contents. This
765
is called the ``pager.''
890
?index? in Mutt. The second mode is the display of the message contents. This
891
is called the ?pager.?
766
892
767
893
The next few sections describe the functions provided in each of these modes.
768
894
769
3.1. The Message Index
895
4.1. The Message Index
770
896
771
897
Common keys used to navigate through and manage messages in the index are shown
772
in Table 2.3, "Most common message index keys".
898
in Table 2.3, ?Most common message index keys?. How messages are presented in
899
the index menu can be customized using the $index_format variable.
773
900
774
901
Table 2.3. Most common message index keys
775
902
776
┌────────┬───────────────────────────────────────────┐
777
│ Key │ Description │
778
├────────┼───────────────────────────────────────────┤
779
│c │change to a different mailbox │
780
├────────┼───────────────────────────────────────────┤
781
│ESC c │change to a folder in read-only mode │
782
├────────┼───────────────────────────────────────────┤
783
│C │copy the current message to another mailbox│
784
├────────┼───────────────────────────────────────────┤
785
│ESC C │decode a message and copy it to a folder │
786
├────────┼───────────────────────────────────────────┤
787
│ESC s │decode a message and save it to a folder │
788
├────────┼───────────────────────────────────────────┤
789
│D │delete messages matching a pattern │
790
├────────┼───────────────────────────────────────────┤
791
│d │delete the current message │
792
├────────┼───────────────────────────────────────────┤
793
│F │mark as important │
794
├────────┼───────────────────────────────────────────┤
795
│l │show messages matching a pattern │
796
├────────┼───────────────────────────────────────────┤
797
│N │mark message as new │
798
├────────┼───────────────────────────────────────────┤
799
│o │change the current sort method │
800
├────────┼───────────────────────────────────────────┤
801
│O │reverse sort the mailbox │
802
├────────┼───────────────────────────────────────────┤
803
│q │save changes and exit │
804
├────────┼───────────────────────────────────────────┤
805
│s │save-message │
806
├────────┼───────────────────────────────────────────┤
807
│T │tag messages matching a pattern │
808
├────────┼───────────────────────────────────────────┤
809
│t │toggle the tag on a message │
810
├────────┼───────────────────────────────────────────┤
811
│ESC t │toggle tag on entire message thread │
812
├────────┼───────────────────────────────────────────┤
813
│U │undelete messages matching a pattern │
814
├────────┼───────────────────────────────────────────┤
815
│u │undelete-message │
816
├────────┼───────────────────────────────────────────┤
817
│v │view-attachments │
818
├────────┼───────────────────────────────────────────┤
819
│x │abort changes and exit │
820
├────────┼───────────────────────────────────────────┤
821
│<Return>│display-message │
822
├────────┼───────────────────────────────────────────┤
823
│<Tab> │jump to the next new or unread message │
824
├────────┼───────────────────────────────────────────┤
825
│@ │show the author's full e-mail address │
826
├────────┼───────────────────────────────────────────┤
827
│$ │save changes to mailbox │
828
├────────┼───────────────────────────────────────────┤
829
│/ │search │
830
├────────┼───────────────────────────────────────────┤
831
│ESC / │search-reverse │
832
├────────┼───────────────────────────────────────────┤
833
│^L │clear and redraw the screen │
834
├────────┼───────────────────────────────────────────┤
835
│^T │untag messages matching a pattern │
836
└────────┴───────────────────────────────────────────┘
837
838
839
3.1.1. Status Flags
903
+----------------------------------------------------+
904
| Key | Description |
905
|--------+-------------------------------------------|
906
|c |change to a different mailbox |
907
|--------+-------------------------------------------|
908
|Esc c |change to a folder in read-only mode |
909
|--------+-------------------------------------------|
910
|C |copy the current message to another mailbox|
911
|--------+-------------------------------------------|
912
|Esc C |decode a message and copy it to a folder |
913
|--------+-------------------------------------------|
914
|Esc s |decode a message and save it to a folder |
915
|--------+-------------------------------------------|
916
|D |delete messages matching a pattern |
917
|--------+-------------------------------------------|
918
|d |delete the current message |
919
|--------+-------------------------------------------|
920
|F |mark as important |
921
|--------+-------------------------------------------|
922
|l |show messages matching a pattern |
923
|--------+-------------------------------------------|
924
|N |mark message as new |
925
|--------+-------------------------------------------|
926
|o |change the current sort method |
927
|--------+-------------------------------------------|
928
|O |reverse sort the mailbox |
929
|--------+-------------------------------------------|
930
|q |save changes and exit |
931
|--------+-------------------------------------------|
932
|s |save-message |
933
|--------+-------------------------------------------|
934
|T |tag messages matching a pattern |
935
|--------+-------------------------------------------|
936
|t |toggle the tag on a message |
937
|--------+-------------------------------------------|
938
|Esc t |toggle tag on entire message thread |
939
|--------+-------------------------------------------|
940
|U |undelete messages matching a pattern |
941
|--------+-------------------------------------------|
942
|u |undelete-message |
943
|--------+-------------------------------------------|
944
|v |view-attachments |
945
|--------+-------------------------------------------|
946
|x |abort changes and exit |
947
|--------+-------------------------------------------|
948
|<Return>|display-message |
949
|--------+-------------------------------------------|
950
|<Tab> |jump to the next new or unread message |
951
|--------+-------------------------------------------|
952
|@ |show the author's full e-mail address |
953
|--------+-------------------------------------------|
954
|$ |save changes to mailbox |
955
|--------+-------------------------------------------|
956
|/ |search |
957
|--------+-------------------------------------------|
958
|Esc / |search-reverse |
959
|--------+-------------------------------------------|
960
|^L |clear and redraw the screen |
961
|--------+-------------------------------------------|
962
|^T |untag messages matching a pattern |
963
+----------------------------------------------------+
964
840
965
841
966
In addition to who sent the message and the subject, a short summary of the
842
967
disposition of each message is printed beside the message number. Zero or more
843
of the following ``flags'' may appear, which mean:
844
845
D
846
847
message is deleted (is marked for deletion)
848
849
d
850
851
message have attachments marked for deletion
852
853
K
854
855
contains a PGP public key
856
857
N
858
859
message is new
860
861
O
862
863
message is old
864
865
P
866
867
message is PGP encrypted
868
869
r
870
871
message has been replied to
872
873
S
874
875
message is signed, and the signature is successfully verified
876
877
s
878
879
message is signed
880
881
!
882
883
message is flagged
884
885
*
886
887
message is tagged
888
889
Some of the status flags can be turned on or off using
890
891
● set-flag (default: w)
892
893
● clear-flag (default: W)
894
895
Furthermore, the following flags reflect who the message is addressed to. They
896
can be customized with the $to_chars variable.
897
898
+
899
900
message is to you and you only
901
902
T
903
904
message is to you, but also to or cc'ed to others
905
906
C
907
908
message is cc'ed to you
909
910
F
911
912
message is from you
913
914
L
915
916
message is sent to a subscribed mailing list
917
918
3.2. The Pager
919
920
By default, Mutt uses its builtin pager to display the body of messages. The
921
pager is very similar to the Unix program less though not nearly as featureful.
922
923
Table 2.4. Most common pager keys
924
925
┌────────┬──────────────────────────────────────────────────────────────────┐
926
│ Key │ Description │
927
├────────┼──────────────────────────────────────────────────────────────────┤
928
│<Return>│go down one line │
929
├────────┼──────────────────────────────────────────────────────────────────┤
930
│<Space> │display the next page (or next message if at the end of a message)│
931
├────────┼──────────────────────────────────────────────────────────────────┤
932
│- │go back to the previous page │
933
├────────┼──────────────────────────────────────────────────────────────────┤
934
│n │search for next match │
935
├────────┼──────────────────────────────────────────────────────────────────┤
936
│S │skip beyond quoted text │
937
├────────┼──────────────────────────────────────────────────────────────────┤
938
│T │toggle display of quoted text │
939
├────────┼──────────────────────────────────────────────────────────────────┤
940
│? │show keybindings │
941
├────────┼──────────────────────────────────────────────────────────────────┤
942
│/ │search for a regular expression (pattern) │
943
├────────┼──────────────────────────────────────────────────────────────────┤
944
│ESC / │search backwards for a regular expression │
945
├────────┼──────────────────────────────────────────────────────────────────┤
946
│\ │toggle search pattern coloring │
947
├────────┼──────────────────────────────────────────────────────────────────┤
948
│^ │jump to the top of the message │
949
└────────┴──────────────────────────────────────────────────────────────────┘
950
951
952
In addition to key bindings in Table 2.4, "Most common pager keys", many of the
953
functions from the index are available in the pager, such as delete-message or
954
copy-message (this is one advantage over using an external pager to view
955
messages).
968
of the ?flags? in Table 2.4, ?Message status flags? may appear, some of which
969
can be turned on or off using these functions: <set-flag> and <clear-flag>
970
bound by default to ?w? and ?W? respectively.
971
972
Furthermore, the flags in Table 2.5, ?Message recipient flags? reflect who the
973
message is addressed to. They can be customized with the $to_chars variable.
974
975
Table 2.4. Message status flags
976
977
+------------------------------------------------------------------+
978
|Flag| Description |
979
|----+-------------------------------------------------------------|
980
|D |message is deleted (is marked for deletion) |
981
|----+-------------------------------------------------------------|
982
|d |message has attachments marked for deletion |
983
|----+-------------------------------------------------------------|
984
|K |contains a PGP public key |
985
|----+-------------------------------------------------------------|
986
|N |message is new |
987
|----+-------------------------------------------------------------|
988
|O |message is old |
989
|----+-------------------------------------------------------------|
990
|P |message is PGP encrypted |
991
|----+-------------------------------------------------------------|
992
|r |message has been replied to |
993
|----+-------------------------------------------------------------|
994
|S |message is signed, and the signature is successfully verified|
995
|----+-------------------------------------------------------------|
996
|s |message is signed |
997
|----+-------------------------------------------------------------|
998
|! |message is flagged |
999
|----+-------------------------------------------------------------|
1000
|* |message is tagged |
1001
+------------------------------------------------------------------+
1002
1003
1004
Table 2.5. Message recipient flags
1005
1006
+------------------------------------------------------+
1007
|Flag| Description |
1008
|----+-------------------------------------------------|
1009
|+ |message is to you and you only |
1010
|----+-------------------------------------------------|
1011
|T |message is to you, but also to or cc'ed to others|
1012
|----+-------------------------------------------------|
1013
|C |message is cc'ed to you |
1014
|----+-------------------------------------------------|
1015
|F |message is from you |
1016
|----+-------------------------------------------------|
1017
|L |message is sent to a subscribed mailing list |
1018
+------------------------------------------------------+
1019
1020
1021
4.2. The Pager
1022
1023
By default, Mutt uses its builtin pager to display the contents of messages.
1024
The pager is very similar to the Unix program less though not nearly as
1025
featureful.
1026
1027
Table 2.6. Most common pager keys
1028
1029
+---------------------------------------------------------------------------+
1030
| Key | Description |
1031
|--------+------------------------------------------------------------------|
1032
|<Return>|go down one line |
1033
|--------+------------------------------------------------------------------|
1034
|<Space> |display the next page (or next message if at the end of a message)|
1035
|--------+------------------------------------------------------------------|
1036
|- |go back to the previous page |
1037
|--------+------------------------------------------------------------------|
1038
|n |search for next match |
1039
|--------+------------------------------------------------------------------|
1040
|S |skip beyond quoted text |
1041
|--------+------------------------------------------------------------------|
1042
|T |toggle display of quoted text |
1043
|--------+------------------------------------------------------------------|
1044
|? |show keybindings |
1045
|--------+------------------------------------------------------------------|
1046
|/ |regular expression search |
1047
|--------+------------------------------------------------------------------|
1048
|Esc / |backward regular expression search |
1049
|--------+------------------------------------------------------------------|
1050
|\ |toggle highlighting of search matches |
1051
|--------+------------------------------------------------------------------|
1052
|^ |jump to the top of the message |
1053
+---------------------------------------------------------------------------+
1054
1055
1056
In addition to key bindings in Table 2.6, ?Most common pager keys?, many of the
1057
functions from the index menu are also available in the pager, such as
1058
<delete-message> or <copy-message> (this is one advantage over using an
1059
external pager to view messages).
956
1060
957
1061
Also, the internal pager supports a couple other advanced features. For one, it
958
will accept and translate the ``standard'' nroff sequences for bold and
1062
will accept and translate the ?standard? nroff sequences for bold and
959
1063
underline. These sequences are a series of either the letter, backspace (^H),
960
the letter again for bold or the letter, backspace, ``_'' for denoting
961
underline. Mutt will attempt to display these in bold and underline
962
respectively if your terminal supports them. If not, you can use the bold and
963
underline color objects to specify a color or mono attribute for them.
1064
the letter again for bold or the letter, backspace, ?_? for denoting underline.
1065
Mutt will attempt to display these in bold and underline respectively if your
1066
terminal supports them. If not, you can use the bold and underline color
1067
objects to specify a color or mono attribute for them.
964
1068
965
1069
Additionally, the internal pager supports the ANSI escape sequences for
966
1070
character attributes. Mutt translates them into the correct color and character
967
settings. The sequences Mutt supports are '\e[Ps;Ps;..Ps;m' where Ps can be one
968
of the codes shown in Table 2.5, "ANSI escape sequences".
969
970
Table 2.5. ANSI escape sequences
971
972
┌───────────┬──────────────────────────────────────────────────────────────┐
973
│Escape code│ Description │
974
├───────────┼──────────────────────────────────────────────────────────────┤
975
│0 │All Attributes Off │
976
├───────────┼──────────────────────────────────────────────────────────────┤
977
│1 │Bold on │
978
├───────────┼──────────────────────────────────────────────────────────────┤
979
│4 │Underline on │
980
├───────────┼──────────────────────────────────────────────────────────────┤
981
│5 │Blink on │
982
├───────────┼──────────────────────────────────────────────────────────────┤
983
│7 │Reverse video on │
984
├───────────┼──────────────────────────────────────────────────────────────┤
985
│3<color> │Foreground color is <color> (see Table 2.6, "Color sequences")│
986
├───────────┼──────────────────────────────────────────────────────────────┤
987
│4<color> │Background color is <color> (see Table 2.6, "Color sequences")│
988
└───────────┴──────────────────────────────────────────────────────────────┘
989
990
991
Table 2.6. Color sequences
992
993
┌───────────┬───────┐
994
│Color code │ Color │
995
├───────────┼───────┤
996
│0 │Black │
997
├───────────┼───────┤
998
│1 │Red │
999
├───────────┼───────┤
1000
│2 │Green │
1001
├───────────┼───────┤
1002
│3 │Yellow │
1003
├───────────┼───────┤
1004
│4 │Blue │
1005
├───────────┼───────┤
1006
│5 │Magenta│
1007
├───────────┼───────┤
1008
│6 │Cyan │
1009
├───────────┼───────┤
1010
│7 │White │
1011
└───────────┴───────┘
1071
settings. The sequences Mutt supports are:
1072
1073
\e[Ps;Ps;..Ps;m
1074
1075
where Ps can be one of the codes shown in Table 2.7, ?ANSI escape sequences?.
1076
1077
Table 2.7. ANSI escape sequences
1078
1079
+--------------------------------------------------------------------------+
1080
|Escape code| Description |
1081
|-----------+--------------------------------------------------------------|
1082
|0 |All attributes off |
1083
|-----------+--------------------------------------------------------------|
1084
|1 |Bold on |
1085
|-----------+--------------------------------------------------------------|
1086
|4 |Underline on |
1087
|-----------+--------------------------------------------------------------|
1088
|5 |Blink on |
1089
|-----------+--------------------------------------------------------------|
1090
|7 |Reverse video on |
1091
|-----------+--------------------------------------------------------------|
1092
|3<color> |Foreground color is <color> (see Table 2.8, ?Color sequences?)|
1093
|-----------+--------------------------------------------------------------|
1094
|4<color> |Background color is <color> (see Table 2.8, ?Color sequences?)|
1095
+--------------------------------------------------------------------------+
1096
1097
1098
Table 2.8. Color sequences
1099
1100
+-------------------+
1101
|Color code | Color |
1102
|-----------+-------|
1103
|0 |Black |
1104
|-----------+-------|
1105
|1 |Red |
1106
|-----------+-------|
1107
|2 |Green |
1108
|-----------+-------|
1109
|3 |Yellow |
1110
|-----------+-------|
1111
|4 |Blue |
1112
|-----------+-------|
1113
|5 |Magenta|
1114
|-----------+-------|
1115
|6 |Cyan |
1116
|-----------+-------|
1117
|7 |White |
1118
+-------------------+
1012
1119
1013
1120
1014
1121
Mutt uses these attributes for handling text/enriched messages, and they can
1015
also be used by an external autoview script for highlighting purposes. Note: If
1016
you change the colors for your display, for example by changing the color
1122
also be used by an external autoview script for highlighting purposes.
1123
1124
Note
1125
1126
If you change the colors for your display, for example by changing the color
1017
1127
associated with color2 for your xterm, then that color will be used instead of
1018
1128
green.
1019
1129
1020
3.3. Threaded Mode
1130
Note
1131
1132
Note that the search commands in the pager take regular expressions, which are
1133
not quite the same as the more complex patterns used by the search command in
1134
the index. This is because the pager only performs simple text search, whereas
1135
the index provides boolean filtering on several aspects of messages.
1136
1137
4.3. Threaded Mode
1021
1138
1022
1139
When the mailbox is sorted by threads, there are a few additional functions
1023
available in the index and pager modes as shown in Table 2.7, "Most common
1024
thread mode keys".
1025
1026
Table 2.7. Most common thread mode keys
1027
1028
┌─────┬──────────────────┬──────────────────────────────────────────────┐
1029
│ Key │ Function │ Description │
1030
├─────┼──────────────────┼──────────────────────────────────────────────┤
1031
│^D │delete-thread │delete all messages in the current thread │
1032
├─────┼──────────────────┼──────────────────────────────────────────────┤
1033
│^U │undelete-thread │undelete all messages in the current thread │
1034
├─────┼──────────────────┼──────────────────────────────────────────────┤
1035
│^N │next-thread │jump to the start of the next thread │
1036
├─────┼──────────────────┼──────────────────────────────────────────────┤
1037
│^P │previous-thread │jump to the start of the previous thread │
1038
├─────┼──────────────────┼──────────────────────────────────────────────┤
1039
│^R │read-thread │mark the current thread as read │
1040
├─────┼──────────────────┼──────────────────────────────────────────────┤
1041
│ESC d│delete-subthread │delete all messages in the current subthread │
1042
├─────┼──────────────────┼──────────────────────────────────────────────┤
1043
│ESC u│undelete-subthread│undelete all messages in the current subthread│
1044
├─────┼──────────────────┼──────────────────────────────────────────────┤
1045
│ESC n│next-subthread │jump to the start of the next subthread │
1046
├─────┼──────────────────┼──────────────────────────────────────────────┤
1047
│ESC p│previous-subthread│jump to the start of the previous subthread │
1048
├─────┼──────────────────┼──────────────────────────────────────────────┤
1049
│ESC r│read-subthread │mark the current subthread as read │
1050
├─────┼──────────────────┼──────────────────────────────────────────────┤
1051
│ESC t│tag-thread │toggle the tag on the current thread │
1052
├─────┼──────────────────┼──────────────────────────────────────────────┤
1053
│ESC v│collapse-thread │toggle collapse for the current thread │
1054
├─────┼──────────────────┼──────────────────────────────────────────────┤
1055
│ESC V│collapse-all │toggle collapse for all threads │
1056
├─────┼──────────────────┼──────────────────────────────────────────────┤
1057
│P │parent-message │jump to parent message in thread │
1058
└─────┴──────────────────┴──────────────────────────────────────────────┘
1059
1060
1061
Note: Collapsing a thread displays only the first message in the thread and
1062
hides the others. This is useful when threads contain so many messages that you
1063
can only see a handful of threads on the screen. See %M in $index_format. For
1064
example, you could use "%?M?(#%03M)&(%4l)?" in $index_format to optionally
1065
display the number of hidden messages if the thread is collapsed.
1140
available in the index and pager modes as shown in Table 2.9, ?Most common
1141
thread mode keys?.
1142
1143
Table 2.9. Most common thread mode keys
1144
1145
+-------------------------------------------------------------------------+
1146
| Key | Function | Description |
1147
|-----+--------------------+----------------------------------------------|
1148
|^D |<delete-thread> |delete all messages in the current thread |
1149
|-----+--------------------+----------------------------------------------|
1150
|^U |<undelete-thread> |undelete all messages in the current thread |
1151
|-----+--------------------+----------------------------------------------|
1152
|^N |<next-thread> |jump to the start of the next thread |
1153
|-----+--------------------+----------------------------------------------|
1154
|^P |<previous-thread> |jump to the start of the previous thread |
1155
|-----+--------------------+----------------------------------------------|
1156
|^R |<read-thread> |mark the current thread as read |
1157
|-----+--------------------+----------------------------------------------|
1158
|Esc d|<delete-subthread> |delete all messages in the current subthread |
1159
|-----+--------------------+----------------------------------------------|
1160
|Esc u|<undelete-subthread>|undelete all messages in the current subthread|
1161
|-----+--------------------+----------------------------------------------|
1162
|Esc n|<next-subthread> |jump to the start of the next subthread |
1163
|-----+--------------------+----------------------------------------------|
1164
|Esc p|<previous-subthread>|jump to the start of the previous subthread |
1165
|-----+--------------------+----------------------------------------------|
1166
|Esc r|<read-subthread> |mark the current subthread as read |
1167
|-----+--------------------+----------------------------------------------|
1168
|Esc t|<tag-thread> |toggle the tag on the current thread |
1169
|-----+--------------------+----------------------------------------------|
1170
|Esc v|<collapse-thread> |toggle collapse for the current thread |
1171
|-----+--------------------+----------------------------------------------|
1172
|Esc V|<collapse-all> |toggle collapse for all threads |
1173
|-----+--------------------+----------------------------------------------|
1174
|P |<parent-message> |jump to parent message in thread |
1175
+-------------------------------------------------------------------------+
1176
1177
1178
Note
1179
1180
Collapsing a thread displays only the first message in the thread and hides the
1181
others. This is useful when threads contain so many messages that you can only
1182
see a handful of threads on the screen. See %M in $index_format. For example,
1183
you could use "%?M?(#%03M)&(%4l)?" in $index_format to optionally display the
1184
number of hidden messages if the thread is collapsed.
1066
1185
1067
1186
See also: $strict_threads.
1068
1187
1069
3.4. Miscellaneous Functions
1070
1071
create-alias (default: a)
1072
1073
Creates a new alias based upon the current message (or prompts for a new one).
1074
Once editing is complete, an alias command is added to the file specified by
1075
the $alias_file variable for future use. Note: Specifying an $alias_file does
1076
not add the aliases specified there-in, you must also source the file.
1077
1078
check-traditional-pgp (default: ESC P)
1079
1080
This function will search the current message for content signed or encrypted
1081
with PGP the "traditional" way, that is, without proper MIME tagging.
1082
Technically, this function will temporarily change the MIME content types of
1083
the body parts containing PGP data; this is similar to the edit-type function's
1084
effect.
1085
1086
display-toggle-weed (default: h)
1087
1088
Toggles the weeding of message header fields specified by ignore commands.
1089
1090
edit (default: e)
1091
1092
This command (available in the ``index'' and ``pager'') allows you to edit the
1093
raw current message as it's present in the mail folder. After you have finished
1094
editing, the changed message will be appended to the current folder, and the
1095
original message will be marked for deletion.
1096
1097
edit-type (default: ^E on the attachment menu, and in the pager and index
1098
menus; ^T on the compose menu)
1099
1100
This command is used to temporarily edit an attachment's content type to fix,
1101
for instance, bogus character set parameters. When invoked from the index or
1102
from the pager, you'll have the opportunity to edit the top-level attachment's
1103
content type. On the attachment menu, you can change any attachment's content
1104
type. These changes are not persistent, and get lost upon changing folders.
1105
1106
Note that this command is also available on the compose menu. There, it's used
1107
to fine-tune the properties of attachments you are going to send.
1108
1109
enter-command (default: ``:'')
1110
1111
This command is used to execute any command you would normally put in a
1112
configuration file. A common use is to check the settings of variables, or in
1113
conjunction with macros to change settings on the fly.
1114
1115
extract-keys (default: ^K)
1116
1117
This command extracts PGP public keys from the current or tagged message(s) and
1118
adds them to your PGP public key ring.
1119
1120
forget-passphrase (default: ^F)
1121
1122
This command wipes the passphrase(s) from memory. It is useful, if you
1123
misspelled the passphrase.
1124
1125
list-reply (default: L)
1126
1127
Reply to the current or tagged message(s) by extracting any addresses which
1128
match the regular expressions given by the lists or subscribe commands, but
1129
also honor any Mail-Followup-To header(s) if the $honor_followup_to
1130
configuration variable is set. Using this when replying to messages posted to
1131
mailing lists helps avoid duplicate copies being sent to the author of the
1132
message you are replying to.
1133
1134
pipe-message (default: |)
1135
1136
Asks for an external Unix command and pipes the current or tagged message(s) to
1137
it. The variables $pipe_decode, $pipe_split, $pipe_sep and $wait_key control
1138
the exact behavior of this function.
1139
1140
resend-message (default: ESC e)
1141
1142
With resend-message, mutt takes the current message as a template for a new
1143
message. This function is best described as "recall from arbitrary folders". It
1144
can conveniently be used to forward MIME messages while preserving the original
1145
mail structure. Note that the amount of headers included here depends on the
1146
value of the $weed variable.
1147
1148
This function is also available from the attachment menu. You can use this to
1149
easily resend a message which was included with a bounce message as a message/
1150
rfc822 body part.
1151
1152
shell-escape (default: !)
1153
1154
Asks for an external Unix command and executes it. The $wait_key can be used to
1155
control whether Mutt will wait for a key to be pressed when the command returns
1156
(presumably to let the user read the output of the command), based on the
1157
return status of the named command.
1158
1159
toggle-quoted (default: T)
1160
1161
The pager uses the $quote_regexp variable to detect quoted text when displaying
1162
the body of the message. This function toggles the display of the quoted
1163
material in the message. It is particularly useful when are interested in just
1164
the response and there is a large amount of quoted text in the way.
1165
1166
skip-quoted (default: S)
1167
1168
This function will go to the next line of non-quoted text which come after a
1169
line of quoted text in the internal pager.
1170
1171
4. Sending Mail
1172
1173
The bindings shown in Table 2.8, "Most common mail sending keys" are available
1174
in the index for sending messages.
1175
1176
Table 2.8. Most common mail sending keys
1177
1178
┌─────┬───────────┬────────────────────────────────┐
1179
│ Key │ Function │ Description │
1180
├─────┼───────────┼────────────────────────────────┤
1181
│m │compose │compose a new message │
1182
├─────┼───────────┼────────────────────────────────┤
1183
│r │reply │reply to sender │
1184
├─────┼───────────┼────────────────────────────────┤
1185
│g │group-reply│reply to all recipients │
1186
├─────┼───────────┼────────────────────────────────┤
1187
│L │list-reply │reply to mailing list address │
1188
├─────┼───────────┼────────────────────────────────┤
1189
│f │forward │forward message │
1190
├─────┼───────────┼────────────────────────────────┤
1191
│b │bounce │bounce (remail) message │
1192
├─────┼───────────┼────────────────────────────────┤
1193
│ESC k│mail-key │mail a PGP public key to someone│
1194
└─────┴───────────┴────────────────────────────────┘
1195
1196
1197
Bouncing a message sends the message as is to the recipient you specify.
1188
4.4. Miscellaneous Functions
1189
1190
In addition, the index and pager menus have these interesting functions:
1191
1192
<create-alias> (default: a)
1193
1194
Creates a new alias based upon the current message (or prompts for a new
1195
one). Once editing is complete, an alias command is added to the file
1196
specified by the $alias_file variable for future use
1197
1198
Note
1199
1200
Mutt does not read the $alias_file upon startup so you must explicitly
1201
source the file.
1202
1203
<check-traditional-pgp> (default: Esc P)
1204
1205
This function will search the current message for content signed or
1206
encrypted with PGP the ?traditional? way, that is, without proper MIME
1207
tagging. Technically, this function will temporarily change the MIME
1208
content types of the body parts containing PGP data; this is similar to the
1209
<edit-type> function's effect.
1210
1211
<edit> (default: e)
1212
1213
This command (available in the index and pager) allows you to edit the raw
1214
current message as it's present in the mail folder. After you have finished
1215
editing, the changed message will be appended to the current folder, and
1216
the original message will be marked for deletion; if the message is
1217
unchanged it won't be replaced.
1218
1219
<edit-type> (default: ^E on the attachment menu, and in the pager and index
1220
menus; ^T on the compose menu)
1221
1222
This command is used to temporarily edit an attachment's content type to
1223
fix, for instance, bogus character set parameters. When invoked from the
1224
index or from the pager, you'll have the opportunity to edit the top-level
1225
attachment's content type. On the attachment menu, you can change any
1226
attachment's content type. These changes are not persistent, and get lost
1227
upon changing folders.
1228
1229
Note that this command is also available on the compose menu. There, it's
1230
used to fine-tune the properties of attachments you are going to send.
1231
1232
<enter-command> (default: ?:?)
1233
1234
This command is used to execute any command you would normally put in a
1235
configuration file. A common use is to check the settings of variables, or
1236
in conjunction with macros to change settings on the fly.
1237
1238
<extract-keys> (default: ^K)
1239
1240
This command extracts PGP public keys from the current or tagged message(s)
1241
and adds them to your PGP public key ring.
1242
1243
<forget-passphrase> (default: ^F)
1244
1245
This command wipes the passphrase(s) from memory. It is useful, if you
1246
misspelled the passphrase.
1247
1248
<list-reply> (default: L)
1249
1250
Reply to the current or tagged message(s) by extracting any addresses which
1251
match the regular expressions given by the lists or subscribe commands, but
1252
also honor any Mail-Followup-To header(s) if the $honor_followup_to
1253
configuration variable is set. Using this when replying to messages posted
1254
to mailing lists helps avoid duplicate copies being sent to the author of
1255
the message you are replying to.
1256
1257
<pipe-message> (default: |)
1258
1259
Asks for an external Unix command and pipes the current or tagged message
1260
(s) to it. The variables $pipe_decode, $pipe_split, $pipe_sep and $wait_key
1261
control the exact behavior of this function.
1262
1263
<resend-message> (default: Esc e)
1264
1265
Mutt takes the current message as a template for a new message. This
1266
function is best described as "recall from arbitrary folders". It can
1267
conveniently be used to forward MIME messages while preserving the original
1268
mail structure. Note that the amount of headers included here depends on
1269
the value of the $weed variable.
1270
1271
This function is also available from the attachment menu. You can use this
1272
to easily resend a message which was included with a bounce message as a
1273
message/rfc822 body part.
1274
1275
<shell-escape> (default: !)
1276
1277
Asks for an external Unix command and executes it. The $wait_key can be
1278
used to control whether Mutt will wait for a key to be pressed when the
1279
command returns (presumably to let the user read the output of the
1280
command), based on the return status of the named command. If no command is
1281
given, an interactive shell is executed.
1282
1283
<toggle-quoted> (default: T)
1284
1285
The pager uses the $quote_regexp variable to detect quoted text when
1286
displaying the body of the message. This function toggles the display of
1287
the quoted material in the message. It is particularly useful when being
1288
interested in just the response and there is a large amount of quoted text
1289
in the way.
1290
1291
<skip-quoted> (default: S)
1292
1293
This function will go to the next line of non-quoted text which comes after
1294
a line of quoted text in the internal pager.
1295
1296
5. Sending Mail
1297
1298
5.1. Introduction
1299
1300
The bindings shown in Table 2.10, ?Most common mail sending keys? are available
1301
in the index and pager to start a new message.
1302
1303
Table 2.10. Most common mail sending keys
1304
1305
+----------------------------------------------------+
1306
| Key | Function | Description |
1307
|-----+-------------+--------------------------------|
1308
|m |<compose> |compose a new message |
1309
|-----+-------------+--------------------------------|
1310
|r |<reply> |reply to sender |
1311
|-----+-------------+--------------------------------|
1312
|g |<group-reply>|reply to all recipients |
1313
|-----+-------------+--------------------------------|
1314
|L |<list-reply> |reply to mailing list address |
1315
|-----+-------------+--------------------------------|
1316
|f |<forward> |forward message |
1317
|-----+-------------+--------------------------------|
1318
|b |<bounce> |bounce (remail) message |
1319
|-----+-------------+--------------------------------|
1320
|Esc k|<mail-key> |mail a PGP public key to someone|
1321
+----------------------------------------------------+
1322
1323
1324
Bouncing a message sends the message as-is to the recipient you specify.
1198
1325
Forwarding a message allows you to add comments or modify the message you are
1199
forwarding. These items are discussed in greater detail in the next chapter ``
1200
Forwarding and Bouncing Mail.''
1326
forwarding. These items are discussed in greater detail in the next chapter ?
1327
Forwarding and Bouncing Mail.?
1201
1328
1202
1329
Mutt will then enter the compose menu and prompt you for the recipients to
1203
place on the ``To:'' header field. Next, it will ask you for the ``Subject:''
1204
field for the message, providing a default if you are replying to or forwarding
1205
a message. See also $askcc, $askbcc, $autoedit, $bounce, $fast_reply, and
1330
place on the ?To:? header field. Next, it will ask you for the ?Subject:? field
1331
for the message, providing a default if you are replying to or forwarding a
1332
message. See also $askcc, $askbcc, $autoedit, $bounce, $fast_reply, and
1206
1333
$include for changing how Mutt asks these questions.
1207
1334
1208
1335
Mutt will then automatically start your $editor on the message body. If the
1214
1341
specified a $signature, it will be appended to the message.
1215
1342
1216
1343
Once you have finished editing the body of your mail message, you are returned
1217
to the compose menu providing the functions show in Table 2.9, "Most common
1218
compose menu keys".
1219
1220
Table 2.9. Most common compose menu keys
1221
1222
┌─────┬─────────────────┬────────────────────────────────────────────┐
1223
│ Key │ Function │ Description │
1224
├─────┼─────────────────┼────────────────────────────────────────────┤
1225
│a │attach-file │attach a file │
1226
├─────┼─────────────────┼────────────────────────────────────────────┤
1227
│A │attach-message │attach message(s) to the message │
1228
├─────┼─────────────────┼────────────────────────────────────────────┤
1229
│ESC k│attach-key │attach a PGP public key │
1230
├─────┼─────────────────┼────────────────────────────────────────────┤
1231
│d │edit-description │edit description on attachment │
1232
├─────┼─────────────────┼────────────────────────────────────────────┤
1233
│D │detach-file │detach a file │
1234
├─────┼─────────────────┼────────────────────────────────────────────┤
1235
│t │edit-to │edit the To field │
1236
├─────┼─────────────────┼────────────────────────────────────────────┤
1237
│ESC f│edit-from │edit the From field │
1238
├─────┼─────────────────┼────────────────────────────────────────────┤
1239
│r │edit-reply-to │edit the Reply-To field │
1240
├─────┼─────────────────┼────────────────────────────────────────────┤
1241
│c │edit-cc │edit the Cc field │
1242
├─────┼─────────────────┼────────────────────────────────────────────┤
1243
│b │edit-bcc │edit the Bcc field │
1244
├─────┼─────────────────┼────────────────────────────────────────────┤
1245
│y │send-message │send the message │
1246
├─────┼─────────────────┼────────────────────────────────────────────┤
1247
│s │edit-subject │edit the Subject │
1248
├─────┼─────────────────┼────────────────────────────────────────────┤
1249
│S │smime-menu │select S/MIME options │
1250
├─────┼─────────────────┼────────────────────────────────────────────┤
1251
│f │edit-fcc │specify an ``Fcc'' mailbox │
1252
├─────┼─────────────────┼────────────────────────────────────────────┤
1253
│p │pgp-menu │select PGP options │
1254
├─────┼─────────────────┼────────────────────────────────────────────┤
1255
│P │postpone-message │postpone this message until later │
1256
├─────┼─────────────────┼────────────────────────────────────────────┤
1257
│q │quit │quit (abort) sending the message │
1258
├─────┼─────────────────┼────────────────────────────────────────────┤
1259
│w │write-fcc │write the message to a folder │
1260
├─────┼─────────────────┼────────────────────────────────────────────┤
1261
│i │ispell │check spelling (if available on your system)│
1262
├─────┼─────────────────┼────────────────────────────────────────────┤
1263
│^F │forget-passphrase│wipe passphrase(s) from memory │
1264
└─────┴─────────────────┴────────────────────────────────────────────┘
1265
1266
1267
Note: The attach-message function will prompt you for a folder to attach
1268
messages from. You can now tag messages in that folder and they will be
1269
attached to the message you are sending. Note that certain operations like
1270
composing a new mail, replying, forwarding, etc. are not permitted when you are
1271
in that folder. The %r in $status_format will change to a 'A' to indicate that
1272
you are in attach-message mode.
1273
1274
4.1. Editing the message header
1275
1276
When editing the header of your outgoing message, there are a couple of special
1277
features available.
1278
1279
If you specify Fcc:filename Mutt will pick up filename just as if you had used
1280
the edit-fcc function in the compose menu.
1281
1282
You can also attach files to your message by specifying Attach:filename [
1344
to the compose menu providing the functions shown in Table 2.11, ?Most common
1345
compose menu keys? to modify, send or postpone the message.
1346
1347
Table 2.11. Most common compose menu keys
1348
1349
+----------------------------------------------------------------------+
1350
| Key | Function | Description |
1351
|-----+-------------------+--------------------------------------------|
1352
|a |<attach-file> |attach a file |
1353
|-----+-------------------+--------------------------------------------|
1354
|A |<attach-message> |attach message(s) to the message |
1355
|-----+-------------------+--------------------------------------------|
1356
|Esc k|<attach-key> |attach a PGP public key |
1357
|-----+-------------------+--------------------------------------------|
1358
|d |<edit-description> |edit description on attachment |
1359
|-----+-------------------+--------------------------------------------|
1360
|D |<detach-file> |detach a file |
1361
|-----+-------------------+--------------------------------------------|
1362
|t |<edit-to> |edit the To field |
1363
|-----+-------------------+--------------------------------------------|
1364
|Esc f|<edit-from> |edit the From field |
1365
|-----+-------------------+--------------------------------------------|
1366
|r |<edit-reply-to> |edit the Reply-To field |
1367
|-----+-------------------+--------------------------------------------|
1368
|c |<edit-cc> |edit the Cc field |
1369
|-----+-------------------+--------------------------------------------|
1370
|b |<edit-bcc> |edit the Bcc field |
1371
|-----+-------------------+--------------------------------------------|
1372
|y |<send-message> |send the message |
1373
|-----+-------------------+--------------------------------------------|
1374
|s |<edit-subject> |edit the Subject |
1375
|-----+-------------------+--------------------------------------------|
1376
|S |<smime-menu> |select S/MIME options |
1377
|-----+-------------------+--------------------------------------------|
1378
|f |<edit-fcc> |specify an ?Fcc? mailbox |
1379
|-----+-------------------+--------------------------------------------|
1380
|p |<pgp-menu> |select PGP options |
1381
|-----+-------------------+--------------------------------------------|
1382
|P |<postpone-message> |postpone this message until later |
1383
|-----+-------------------+--------------------------------------------|
1384
|q |<quit> |quit (abort) sending the message |
1385
|-----+-------------------+--------------------------------------------|
1386
|w |<write-fcc> |write the message to a folder |
1387
|-----+-------------------+--------------------------------------------|
1388
|i |<ispell> |check spelling (if available on your system)|
1389
|-----+-------------------+--------------------------------------------|
1390
|^F |<forget-passphrase>|wipe passphrase(s) from memory |
1391
+----------------------------------------------------------------------+
1392
1393
1394
The compose menu is also used to edit the attachments for a message which can
1395
be either files or other messages. The <attach-message> function to will prompt
1396
you for a folder to attach messages from. You can now tag messages in that
1397
folder and they will be attached to the message you are sending.
1398
1399
Note
1400
1401
Note that certain operations like composing a new mail, replying, forwarding,
1402
etc. are not permitted when you are in that folder. The %r in $status_format
1403
will change to a ?A? to indicate that you are in attach-message mode.
1404
1405
5.2. Editing the message header
1406
1407
When editing the header because of $edit_headers being set, there are a several
1408
pseudo headers available which will not be included in sent messages.
1409
1410
5.2.1. Fcc: pseudo header
1411
1412
If you specify Fcc: filename as a header, Mutt will pick up filename just as if
1413
you had used the <edit-fcc> function in the compose menu.
1414
1415
5.2.2. Attach: pseudo header
1416
1417
You can also attach files to your message by specifying Attach: filename [
1283
1418
description ] where filename is the file to attach and description is an
1284
1419
optional string to use as the description of the attached file.
1285
1420
1286
When replying to messages, if you remove the In-Reply-To: field from the header
1287
field, Mutt will not generate a References: field, which allows you to create a
1288
new message thread.
1289
1290
Also see $edit_headers.
1291
1292
4.2. Using Mutt with PGP
1421
5.2.3. Pgp: pseudo header
1293
1422
1294
1423
If you want to use PGP, you can specify
1295
1424
1296
1425
Pgp: [ E | S | S<id> ]
1297
1426
1298
``E'' encrypts, ``S'' signs and ``S<id>'' signs with the given key, setting
1299
$pgp_sign_as permanently.
1300
1301
If you have told mutt to PGP encrypt a message, it will guide you through a key
1302
selection process when you try to send the message. Mutt will not ask you any
1303
questions about keys which have a certified user ID matching one of the message
1304
recipients' mail addresses. However, there may be situations in which there are
1305
several keys, weakly certified user ID fields, or where no matching keys can be
1306
found.
1427
?E? selects encryption, ?S? selects signing and ?S<id>? selects signing with
1428
the given key, setting $pgp_sign_as permanently.
1429
1430
5.2.4. In-Reply-To: header
1431
1432
When replying to messages, the In-Reply-To: header contains the Message-Id of
1433
the message(s) you reply to. If you remove its value, Mutt will not generate a
1434
References: field, which allows you to create a new message thread, for example
1435
to create a new message to a mailing list without having to enter the mailing
1436
list's address.
1437
1438
5.3. Sending cryptographically signed/encrypted messages
1439
1440
If you have told mutt to PGP or S/MIME encrypt a message, it will guide you
1441
through a key selection process when you try to send the message. Mutt will not
1442
ask you any questions about keys which have a certified user ID matching one of
1443
the message recipients' mail addresses. However, there may be situations in
1444
which there are several keys, weakly certified user ID fields, or where no
1445
matching keys can be found.
1307
1446
1308
1447
In these cases, you are dropped into a menu with a list of keys from which you
1309
1448
can select one. When you quit this menu, or mutt can't find any matching keys,
1311
1450
G. When you do so, mutt will return to the compose screen.
1312
1451
1313
1452
Once you have successfully finished the key selection, the message will be
1314
encrypted using the selected public keys, and sent out.
1453
encrypted using the selected public keys when sent out.
1315
1454
1316
1455
Most fields of the entries in the key selection menu (see also
1317
1456
$pgp_entry_format) have obvious meanings. But some explanations on the
1318
1457
capabilities, flags, and validity fields are in order.
1319
1458
1320
The flags sequence (%f) will expand to one of the flags in Table 2.10, "PGP key
1321
menu flags".
1322
1323
Table 2.10. PGP key menu flags
1324
1325
┌────┬──────────────────────────────────────────────────┐
1326
│Flag│ Description │
1327
├────┼──────────────────────────────────────────────────┤
1328
│R │The key has been revoked and can't be used. │
1329
├────┼──────────────────────────────────────────────────┤
1330
│X │The key is expired and can't be used. │
1331
├────┼──────────────────────────────────────────────────┤
1332
│d │You have marked the key as disabled. │
1333
├────┼──────────────────────────────────────────────────┤
1334
│c │There are unknown critical self-signature packets.│
1335
└────┴──────────────────────────────────────────────────┘
1459
The flags sequence (%f) will expand to one of the flags in Table 2.12, ?PGP key
1460
menu flags?.
1461
1462
Table 2.12. PGP key menu flags
1463
1464
+-------------------------------------------------------+
1465
|Flag| Description |
1466
|----+--------------------------------------------------|
1467
|R |The key has been revoked and can't be used. |
1468
|----+--------------------------------------------------|
1469
|X |The key is expired and can't be used. |
1470
|----+--------------------------------------------------|
1471
|d |You have marked the key as disabled. |
1472
|----+--------------------------------------------------|
1473
|c |There are unknown critical self-signature packets.|
1474
+-------------------------------------------------------+
1336
1475
1337
1476
1338
1477
The capabilities field (%c) expands to a two-character sequence representing a
1339
1478
key's capabilities. The first character gives the key's encryption
1340
capabilities: A minus sign (-) means that the key cannot be used for
1341
encryption. A dot (.) means that it's marked as a signature key in one of the
1342
user IDs, but may also be used for encryption. The letter e indicates that this
1343
key can be used for encryption.
1479
capabilities: A minus sign (?-?) means that the key cannot be used for
1480
encryption. A dot (?.?) means that it's marked as a signature key in one of the
1481
user IDs, but may also be used for encryption. The letter ?e? indicates that
1482
this key can be used for encryption.
1344
1483
1345
The second character indicates the key's signing capabilities. Once again, a ``
1346
-'' implies ``not for signing'', ``.'' implies that the key is marked as an
1347
encryption key in one of the user-ids, and ``s'' denotes a key which can be
1348
used for signing.
1484
The second character indicates the key's signing capabilities. Once again, a
1485
?-? implies ?not for signing?, ?.? implies that the key is marked as an
1486
encryption key in one of the user-ids, and ?s? denotes a key which can be used
1487
for signing.
1349
1488
1350
1489
Finally, the validity field (%t) indicates how well-certified a user-id is. A
1351
question mark (?) indicates undefined validity, a minus character (-) marks an
1352
untrusted association, a space character means a partially trusted association,
1353
and a plus character (+) indicates complete validity.
1354
1355
4.3. Sending anonymous messages via mixmaster.
1356
1357
You may also have configured mutt to co-operate with Mixmaster, an anonymous
1490
question mark (???) indicates undefined validity, a minus character (?-?) marks
1491
an untrusted association, a space character means a partially trusted
1492
association, and a plus character (?+?) indicates complete validity.
1493
1494
5.4. Sending anonymous messages via mixmaster
1495
1496
You may also have compiled mutt to co-operate with Mixmaster, an anonymous
1358
1497
remailer. Mixmaster permits you to send your messages anonymously using a chain
1359
1498
of remailers. Mixmaster support in mutt is for mixmaster version 2.04 (beta 45
1360
1499
appears to be the latest) and 2.03. It does not support earlier versions or the
1369
1508
part, you get a list of remailers you may use. In the lower part, you see the
1370
1509
currently selected chain of remailers.
1371
1510
1372
You can navigate in the chain using the chain-prev and chain-next functions,
1373
which are by default bound to the left and right arrows and to the h and l keys
1374
(think vi keyboard bindings). To insert a remailer at the current chain
1375
position, use the insert function. To append a remailer behind the current
1376
chain position, use select-entry or append. You can also delete entries from
1377
the chain, using the corresponding function. Finally, to abandon your changes,
1378
leave the menu, or accept them pressing (by default) the Return key.
1511
You can navigate in the chain using the <chain-prev> and <chain-next>
1512
functions, which are by default bound to the left and right arrows and to the h
1513
and l keys (think vi keyboard bindings). To insert a remailer at the current
1514
chain position, use the <insert> function. To append a remailer behind the
1515
current chain position, use <select-entry> or <append>. You can also delete
1516
entries from the chain, using the corresponding function. Finally, to abandon
1517
your changes, leave the menu, or <accept> them pressing (by default) the Return
1518
key.
1379
1519
1380
1520
Note that different remailers do have different capabilities, indicated in the
1381
1521
%c entry of the remailer menu lines (see $mix_entry_format). Most important is
1382
the ``middleman'' capability, indicated by a capital ``M'': This means that the
1522
the ?middleman? capability, indicated by a capital ?M?: This means that the
1383
1523
remailer in question cannot be used as the final element of a chain, but will
1384
1524
only forward messages to other mixmaster remailers. For details on the other
1385
1525
capabilities, please have a look at the mixmaster documentation.
1386
1526
1387
4.4. Sending format=flowed messages
1527
5.5. Sending format=flowed messages
1388
1528
1389
4.4.1. Concept
1529
5.5.1. Concept
1390
1530
1391
1531
format=flowed-style messages (or f=f for short) are text/plain messages that
1392
1532
consist of paragraphs which a receiver's mail client may reformat to its own
1393
1533
needs which mostly means to customize line lengths regardless of what the
1394
sender sent. Technically this is achieved by letting lines of a ``flowable''
1395
paragraph end in spaces.
1534
sender sent. Technically this is achieved by letting lines of a ?flowable?
1535
paragraph end in spaces except for the last line.
1396
1536
1397
1537
While for text-mode clients like mutt it's the best way to assume only a
1398
1538
standard 80x25 character cell terminal, it may be desired to let the receiver
1399
1539
decide completely how to view a message.
1400
1540
1401
4.4.2. Mutt support
1541
5.5.2. Mutt support
1402
1542
1403
1543
Mutt only supports setting the required format=flowed MIME parameter on
1404
outgoing messages if the $text_flowed variable is set. It does not add the
1405
trailing spaces nor does it provide any other feature related to composing f=f
1406
messages (like reformatting non-f=f parts of a reply to f=f before calling the
1407
editor).
1544
outgoing messages if the $text_flowed variable is set, specifically it does not
1545
add the trailing spaces.
1408
1546
1409
1547
After editing the initial message text and before entering the compose menu,
1410
1548
mutt properly space-stuffes the message. Space-stuffing is required by RfC3676
1411
1549
defining format=flowed and means to prepend a space to:
1412
1550
1413
● all lines starting with a space
1414
1415
● lines starting with the word ``From'' followed by space
1416
1417
● all lines starting with ``>'' which is not intended to be a quote character
1551
* all lines starting with a space
1552
1553
* lines starting with the word ?From? followed by space
1554
1555
* all lines starting with ?>? which is not intended to be a quote character
1556
1557
Note
1558
1559
Mutt only supports space-stuffing for the first two types of lines but not for
1560
the third: It is impossible to safely detect whether a leading > character
1561
starts a quote or not. Furthermore, Mutt only applies space-stuffing once after
1562
the initial edit is finished.
1418
1563
1419
1564
All leading spaces are to be removed by receiving clients to restore the
1420
original message.
1421
1422
Note that mutt only support space-stuffing for the first two types of lines but
1423
not for the third: It is impossible to safely detect whether a leading >
1424
character starts a quote or not.
1425
1426
4.4.3. Editor considerations
1565
original message prior to further processing.
1566
1567
5.5.3. Editor considerations
1427
1568
1428
1569
As mutt provides no additional features to compose f=f messages, it's
1429
1570
completely up to the user and his editor to produce proper messages. Please
1436
1577
For example, vim provides the w flag for its formatoptions setting to assist in
1437
1578
creating f=f messages, see :help fo-table for details.
1438
1579
1439
5. Forwarding and Bouncing Mail
1580
6. Forwarding and Bouncing Mail
1440
1581
1441
1582
Bouncing and forwarding let you send an existing message to recipients that you
1442
specify. Bouncing a message uses the $sendmail command to send a copy to
1443
alternative addresses as if they were the message's original recipients.
1444
Forwarding a message, on the other hand, allows you to modify the message
1445
before it is resent (for example, by adding your own comments). The default key
1446
bindings are shown in Table 2.11, "Message forwarding/bouncing keys".
1447
1448
Table 2.11. Message forwarding/bouncing keys
1449
1450
┌───┬────────┬───────────────────────┐
1451
│Key│Function│ Description │
1452
├───┼────────┼───────────────────────┤
1453
│f │forward │forward message │
1454
├───┼────────┼───────────────────────┤
1455
│b │bounce │bounce (remail) message│
1456
└───┴────────┴───────────────────────┘
1457
1583
specify. Bouncing a message sends a verbatim copy of a message to alternative
1584
addresses as if they were the message's original recipients specified in the
1585
Bcc header. Forwarding a message, on the other hand, allows you to modify the
1586
message before it is resent (for example, by adding your own comments).
1587
Bouncing is done using the <bounce> function and forwarding using the <forward>
1588
function bound to ?b? and ?f? respectively.
1458
1589
1459
1590
Forwarding can be done by including the original message in the new message's
1460
1591
body (surrounded by indicating lines) or including it as a MIME attachment,
1462
1593
like in the pager, can be controlled by the $forward_decode and
1463
1594
$mime_forward_decode variables, respectively. The desired forwarding format may
1464
1595
depend on the content, therefore $mime_forward is a quadoption which, for
1465
example, can be set to ``ask-no''.
1596
example, can be set to ?ask-no?.
1466
1597
1467
1598
The inclusion of headers is controlled by the current setting of the $weed
1468
1599
variable, unless $mime_forward is set.
1470
1601
Editing the message to forward follows the same procedure as sending or
1471
1602
replying to a message does.
1472
1603
1473
6. Postponing Mail
1604
7. Postponing Mail
1474
1605
1475
1606
At times it is desirable to delay sending a message that you have already begun
1476
to compose. When the postpone-message function is used in the compose menu, the
1477
body of your message and attachments are stored in the mailbox specified by the
1478
$postponed variable. This means that you can recall the message even if you
1607
to compose. When the <postpone-message> function is used in the compose menu,
1608
the body of your message and attachments are stored in the mailbox specified by
1609
the $postponed variable. This means that you can recall the message even if you
1479
1610
exit Mutt and then restart it at a later time.
1480
1611
1481
1612
Once a message is postponed, there are several ways to resume it. From the
1482
command line you can use the ``-p'' option, or if you compose a new message
1483
from the index or pager you will be prompted if postponed messages exist. If
1613
command line you can use the ?-p? option, or if you compose a new message from
1614
the index or pager you will be prompted if postponed messages exist. If
1484
1615
multiple messages are currently postponed, the postponed menu will pop up and
1485
1616
you can select which message you would like to resume.
1486
1617
1487
Note: If you postpone a reply to a message, the reply setting of the message is
1488
only updated when you actually finish the message and send it. Also, you must
1489
be in the same folder with the message you replied to for the status of the
1490
message to be updated.
1618
Note
1619
1620
If you postpone a reply to a message, the reply setting of the message is only
1621
updated when you actually finish the message and send it. Also, you must be in
1622
the same folder with the message you replied to for the status of the message
1623
to be updated.
1491
1624
1492
1625
See also the $postpone quad-option.
1493
1626
1495
1628
1496
1629
Table of Contents
1497
1630
1498
1. Syntax of Initialization Files
1499
2. Address groups
1500
3. Defining/Using aliases
1501
4. Changing the default key bindings
1502
5. Defining aliases for character sets
1503
6. Setting variables based upon mailbox
1504
7. Keyboard macros
1505
8. Using color and mono video attributes
1506
9. Ignoring (weeding) unwanted message headers
1507
10. Alternative addresses
1508
11. Mailing lists
1509
12. Using Multiple spool mailboxes
1510
13. Monitoring incoming mail
1511
14. User defined headers
1512
15. Defining the order of headers when viewing messages
1631
1. Location of initialization files
1632
2. Syntax of Initialization Files
1633
3. Address groups
1634
4. Defining/Using aliases
1635
5. Changing the default key bindings
1636
6. Defining aliases for character sets
1637
7. Setting variables based upon mailbox
1638
8. Keyboard macros
1639
9. Using color and mono video attributes
1640
10. Message header display
1641
11. Alternative addresses
1642
12. Mailing lists
1643
13. Using Multiple spool mailboxes
1644
14. Monitoring incoming mail
1645
15. User defined headers
1513
1646
16. Specify default save mailbox
1514
1647
17. Specify default Fcc: mailbox when composing
1515
1648
18. Specify default save filename and default Fcc: mailbox at once
1532
1665
29.1. Basic usage
1533
1666
29.2. Filters
1534
1667
1535
While the default configuration (or ``preferences'') make Mutt usable right out
1668
1. Location of initialization files
1669
1670
While the default configuration (or ?preferences?) make Mutt usable right out
1536
1671
of the box, it is often desirable to tailor Mutt to suit your own tastes. When
1537
Mutt is first invoked, it will attempt to read the ``system'' configuration
1538
file (defaults set by your local system administrator), unless the ``-n''
1539
command line option is specified. This file is typically /usr/local/share/mutt/
1540
Muttrc or /etc/Muttrc. Mutt will next look for a file named .muttrc in your
1541
home directory. If this file does not exist and your home directory has a
1672
Mutt is first invoked, it will attempt to read the ?system? configuration file
1673
(defaults set by your local system administrator), unless the ?-n? command line
1674
option is specified. This file is typically /usr/local/share/mutt/Muttrc or /
1675
etc/Muttrc. Mutt will next look for a file named .muttrc in your home
1676
directory. If this file does not exist and your home directory has a
1542
1677
subdirectory named .mutt, mutt try to load a file named .mutt/muttrc.
1543
1678
1544
1679
.muttrc is the file where you will usually place your commands to configure
1551
1686
file. The same is true of the user configuration file, if you have a file
1552
1687
.muttrc-0.88.6 in your home directory, when you run mutt version 0.88.6, it
1553
1688
will source this file instead of the default .muttrc file. The version number
1554
is the same which is visible using the ``-v'' command line switch or using the
1689
is the same which is visible using the ?-v? command line switch or using the
1555
1690
show-version key (default: V) from the index menu.
1556
1691
1557
1. Syntax of Initialization Files
1692
2. Syntax of Initialization Files
1558
1693
1559
1694
An initialization file consists of a series of commands. Each line of the file
1560
1695
may contain one or more commands. When multiple commands are used, they must be
1561
1696
separated by a semicolon (;).
1562
1697
1698
Example 3.1. Multiple configuration commands per line
1699
1563
1700
set realname='Mutt user' ; ignore x-
1564
1701
1565
The hash mark, or pound sign (``#''), is used as a ``comment'' character. You
1566
can use it to annotate your initialization file. All text after the comment
1702
1703
The hash mark, or pound sign (?#?), is used as a ?comment? character. You can
1704
use it to annotate your initialization file. All text after the comment
1567
1705
character to the end of the line is ignored. For example,
1568
1706
1707
Example 3.2. Commenting configuration files
1708
1569
1709
my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
1570
1710
1711
1571
1712
Single quotes (') and double quotes (") can be used to quote strings which
1572
1713
contain spaces or other special characters. The difference between the two
1573
1714
types of quotes is similar to that of many popular shell programs, namely that
1574
1715
a single quote is used to specify a literal string (one that is not interpreted
1575
1716
for shell variables or quoting with a backslash [see next paragraph]), while
1576
1717
double quotes indicate a string for which should be evaluated. For example,
1577
backtics are evaluated inside of double quotes, but not for single quotes.
1718
backticks are evaluated inside of double quotes, but not for single quotes.
1578
1719
1579
1720
\ quotes the next character, just as in shells such as bash and zsh. For
1580
example, if want to put quotes ``"'' inside of a string, you can use ``\'' to
1581
force the next character to be a literal instead of interpreted character.
1721
example, if want to put quotes ?"? inside of a string, you can use ?\? to force
1722
the next character to be a literal instead of interpreted character.
1723
1724
Example 3.3. Escaping quotes in congfiguration files
1582
1725
1583
1726
set realname="Michael \"MuttDude\" Elkins"
1584
1727
1585
``\\'' means to insert a literal ``\'' into the line. ``\n'' and ``\r'' have
1586
their usual C meanings of linefeed and carriage-return, respectively.
1728
1729
?\\? means to insert a literal ?\? into the line. ?\n? and ?\r? have their
1730
usual C meanings of linefeed and carriage-return, respectively.
1587
1731
1588
1732
A \ at the end of a line can be used to split commands over multiple lines,
1589
1733
provided that the split points don't appear in the middle of command names.
1590
1734
1591
1735
It is also possible to substitute the output of a Unix command in an
1592
initialization file. This is accomplished by enclosing the command in
1593
backquotes (``). For example,
1736
initialization file. This is accomplished by enclosing the command in backticks
1737
(``). For example,
1738
1739
Example 3.4. Using external command's output in configuration files
1594
1740
1595
1741
my_hdr X-Operating-System: `uname -a`
1596
1742
1597
The output of the Unix command ``uname -a'' will be substituted before the line
1598
is parsed. Note that since initialization files are line oriented, only the
1599
first line of output from the Unix command will be substituted.
1600
1601
Both environment variables and mutt variables can be accessed by prepending
1602
``$'' to the name of the variable. For example,
1743
1744
The output of the Unix command ?uname -a? will be substituted before the line
1745
is parsed.
1746
1747
Note
1748
1749
Since initialization files are line oriented, only the first line of output
1750
from the Unix command will be substituted.
1751
1752
Both environment variables and mutt variables can be accessed by prepending ?$?
1753
to the name of the variable. For example,
1754
1755
Example 3.5. Using environment variables in configuration files
1603
1756
1604
1757
set record=+sent_on_$HOSTNAME
1605
1758
1606
will cause mutt to save outgoing messages to a folder named ``sent_on_kremvax''
1607
if the environment variable HOSTNAME is set to ``kremvax.'' (See $record for
1759
1760
will cause mutt to save outgoing messages to a folder named ?sent_on_kremvax?
1761
if the environment variable HOSTNAME is set to ?kremvax.? (See $record for
1608
1762
details.)
1609
1763
1610
1764
Mutt expands the variable when it is assigned, not when it is used. If the
1614
1768
The commands understood by mutt are explained in the next paragraphs. For a
1615
1769
complete list, see the command reference.
1616
1770
1617
2. Address groups
1618
1619
Usage: group [ -groupname [ ... ] ] [ -rxEXPR [ ... ] ] [ -addrEXPR [ ... ] ]
1771
All configuration files are expected to be in the current locale as specified
1772
by the $charset variable which doesn't have a default value since it's
1773
determined by Mutt at startup. If a configuration file is not encoded in the
1774
same character set the $config_charset variable should be used: all lines
1775
starting with the next are recoded from $config_charset to $charset.
1776
1777
This mechanism should be avoided if possible as it has the following
1778
implications:
1779
1780
* These variables should be set early in a configuration file with $charset
1781
preceding $config_charset so Mutt know what character set to convert to.
1782
1783
* If $config_charset is set, it should be set in each configuration file
1784
because the value is global and not per configuration file.
1785
1786
* Because Mutt first recodes a line before it attempts to parse it, a
1787
conversion introducing question marks or other characters as part of errors
1788
(unconvertable characters, transliteration) may introduce syntax errors or
1789
silently change the meaning of certain tokens (e.g. inserting question
1790
marks into regular expressions).
1791
1792
3. Address groups
1793
1794
Usage:
1795
1796
group [ -group name ...] { -rx expr ... | -addr expr ... }
1797
1798
ungroup [ -group name ...] { * | -rx expr ... | -addr expr ... }
1620
1799
1621
1800
group is used to directly add either addresses or regular expressions to the
1622
1801
specified group or groups. The different categories of arguments to the group
1624
1803
strings (that cannot begin with a hyphen) should be interpreted as: either a
1625
1804
regular expression or an email address, respectively.
1626
1805
1627
These address groups can also be created implicitely by the alias, lists,
1806
These address groups can also be created implicitly by the alias, lists,
1628
1807
subscribe and alternates commands by specifying the optional -group option.
1629
1808
1630
1809
Once defined, these address groups can be used in patterns to search for and
1631
1810
limit the display to messages matching a group.
1632
1811
1633
Usage: ungroup [ -groupname [ ... ] ] [ * | [ [ -rxEXPR [ ... ] ] [ -addrEXPR [
1634
... ] ] ]
1635
1636
1812
ungroup is used to remove addresses or regular expressions from the specified
1637
1813
group or groups. The syntax is similar to the group command, however the
1638
1814
special character * can be used to empty a group of all of its contents.
1639
1815
1640
3. Defining/Using aliases
1641
1642
Usage: alias [ -groupname [ ... ] ] keyaddress [ , address, ... ]
1816
4. Defining/Using aliases
1817
1818
Usage:
1819
1820
alias [ -group name ...] key address [ address ...]
1643
1821
1644
1822
It's usually very cumbersome to remember or type out the address of someone you
1645
are communicating with. Mutt allows you to create ``aliases'' which map a short
1823
are communicating with. Mutt allows you to create ?aliases? which map a short
1646
1824
string to a full address.
1647
1825
1648
Note: if you want to create an alias for more than one address, you must
1649
separate the addresses with a comma (``,'').
1826
Note
1827
1828
If you want to create an alias for more than one address, you must separate the
1829
addresses with a comma (?,?).
1650
1830
1651
1831
The optional -group argument to alias causes the aliased address(es) to be
1652
1832
added to the named group.
1653
1833
1654
To remove an alias or aliases (``*'' means all aliases):
1834
To remove an alias or aliases (?*? means all aliases):
1655
1835
1656
unalias [ * | key... ]
1836
unalias [ -group name ...] { * | key ... }
1657
1837
1658
1838
alias muttdude me@cs.hmc.edu (Michael Elkins)
1659
1839
alias theguys manny, moe, jack
1663
1843
this file is sourced. Consequently, you can have multiple alias files, or you
1664
1844
can have all aliases defined in your muttrc.
1665
1845
1666
On the other hand, the create-alias function can use only one file, the one
1667
pointed to by the $alias_file variable (which is ~/.muttrc by default). This
1846
On the other hand, the <create-alias> function can use only one file, the one
1847
pointed to by the $alias_file variable (which is ?/.muttrc by default). This
1668
1848
file is not special either, in the sense that Mutt will happily append aliases
1669
1849
to any file, but in order for the new aliases to take effect you need to
1670
1850
explicitly source this file too.
1671
1851
1672
1852
For example:
1673
1853
1854
Example 3.6. Configuring external alias files
1855
1674
1856
source /usr/local/share/Mutt.aliases
1675
1857
source ~/.mail_aliases
1676
1858
set alias_file=~/.mail_aliases
1677
1859
1860
1678
1861
To use aliases, you merely use the alias at any place in mutt where mutt
1679
1862
prompts for addresses, such as the To: or Cc: prompt. You can also enter
1680
1863
aliases in your editor at the appropriate headers if you have the $edit_headers
1687
1870
the beginning of the prompt or after a comma denoting multiple addresses.
1688
1871
1689
1872
In the alias menu, you can select as many aliases as you want with the
1690
select-entry key (default: RET), and use the exit key (default: q) to return to
1691
the address prompt.
1692
1693
4. Changing the default key bindings
1694
1695
Usage: bindmapkeyfunction
1873
select-entry key (default: <Return>), and use the exit key (default: q) to
1874
return to the address prompt.
1875
1876
5. Changing the default key bindings
1877
1878
Usage:
1879
1880
bind map key function
1696
1881
1697
1882
This command allows you to change the default key bindings (operation invoked
1698
1883
when pressing a key).
1743
1928
1744
1929
pgp
1745
1930
1746
The pgp menu is used to select the OpenPGP keys used for encrypting
1931
The pgp menu is used to select the OpenPGP keys used to encrypt outgoing
1932
messages.
1933
1934
smime
1935
1936
The smime menu is used to select the OpenSSL certificates used to encrypt
1747
1937
outgoing messages.
1748
1938
1749
1939
postpone
1751
1941
The postpone menu is similar to the index menu, except is used when
1752
1942
recalling a message the user was composing, but saved until later.
1753
1943
1944
query
1945
1946
The query menu is the browser for results returned by $query_command.
1947
1948
mix
1949
1950
The mixmaster screen is used to select remailer options for outgoing
1951
messages (if Mutt is compiled with Mixmaster support).
1952
1754
1953
key is the key (or key sequence) you wish to bind. To specify a control
1755
1954
character, use the sequence \Cx, where x is the letter of the control character
1756
(for example, to specify control-A use ``\Ca''). Note that the case of x as
1757
well as \C is ignored, so that \CA, \Ca, \cA and \ca are all equivalent. An
1955
(for example, to specify control-A use ?\Ca?). Note that the case of x as well
1956
as \C is ignored, so that \CA, \Ca, \cA and \ca are all equivalent. An
1758
1957
alternative form is to specify the key as a three digit octal number prefixed
1759
with a ``\'' (for example \177 is equivalent to \c?). In addition, key may be a
1760
symbolic name as shown in Table 3.1, "Symbolic key names".
1958
with a ?\? (for example \177 is equivalent to \c?). In addition, key may be a
1959
symbolic name as shown in Table 3.1, ?Symbolic key names?.
1761
1960
1762
1961
Table 3.1. Symbolic key names
1763
1962
1764
┌─────────────┬───────────────────┐
1765
│Symbolic name│ Meaning │
1766
├─────────────┼───────────────────┤
1767
│\t │tab │
1768
├─────────────┼───────────────────┤
1769
│<tab> │tab │
1770
├─────────────┼───────────────────┤
1771
│<backtab> │backtab / shift-tab│
1772
├─────────────┼───────────────────┤
1773
│\r │carriage return │
1774
├─────────────┼───────────────────┤
1775
│\n │newline │
1776
├─────────────┼───────────────────┤
1777
│\e │escape │
1778
├─────────────┼───────────────────┤
1779
│<esc> │escape │
1780
├─────────────┼───────────────────┤
1781
│<up> │up arrow │
1782
├─────────────┼───────────────────┤
1783
│<down> │down arrow │
1784
├─────────────┼───────────────────┤
1785
│<left> │left arrow │
1786
├─────────────┼───────────────────┤
1787
│<right> │right arrow │
1788
├─────────────┼───────────────────┤
1789
│<pageup> │Page Up │
1790
├─────────────┼───────────────────┤
1791
│<pagedown> │Page Down │
1792
├─────────────┼───────────────────┤
1793
│<backspace> │Backspace │
1794
├─────────────┼───────────────────┤
1795
│<delete> │Delete │
1796
├─────────────┼───────────────────┤
1797
│<insert> │Insert │
1798
├─────────────┼───────────────────┤
1799
│<enter> │Enter │
1800
├─────────────┼───────────────────┤
1801
│<return> │Return │
1802
├─────────────┼───────────────────┤
1803
│<home> │Home │
1804
├─────────────┼───────────────────┤
1805
│<end> │End │
1806
├─────────────┼───────────────────┤
1807
│<space> │Space bar │
1808
├─────────────┼───────────────────┤
1809
│<f1> │function key 1 │
1810
├─────────────┼───────────────────┤
1811
│<f10> │function key 10 │
1812
└─────────────┴───────────────────┘
1813
1814
1815
key does not need to be enclosed in quotes unless it contains a space (`` '').
1963
+---------------------------------+
1964
|Symbolic name| Meaning |
1965
|-------------+-------------------|
1966
|\t |tab |
1967
|-------------+-------------------|
1968
|<tab> |tab |
1969
|-------------+-------------------|
1970
|<backtab> |backtab / shift-tab|
1971
|-------------+-------------------|
1972
|\r |carriage return |
1973
|-------------+-------------------|
1974
|\n |newline |
1975
|-------------+-------------------|
1976
|\e |escape |
1977
|-------------+-------------------|
1978
|<esc> |escape |
1979
|-------------+-------------------|
1980
|<up> |up arrow |
1981
|-------------+-------------------|
1982
|<down> |down arrow |
1983
|-------------+-------------------|
1984
|<left> |left arrow |
1985
|-------------+-------------------|
1986
|<right> |right arrow |
1987
|-------------+-------------------|
1988
|<pageup> |Page Up |
1989
|-------------+-------------------|
1990
|<pagedown> |Page Down |
1991
|-------------+-------------------|
1992
|<backspace> |Backspace |
1993
|-------------+-------------------|
1994
|<delete> |Delete |
1995
|-------------+-------------------|
1996
|<insert> |Insert |
1997
|-------------+-------------------|
1998
|<enter> |Enter |
1999
|-------------+-------------------|
2000
|<return> |Return |
2001
|-------------+-------------------|
2002
|<home> |Home |
2003
|-------------+-------------------|
2004
|<end> |End |
2005
|-------------+-------------------|
2006
|<space> |Space bar |
2007
|-------------+-------------------|
2008
|<f1> |function key 1 |
2009
|-------------+-------------------|
2010
|<f10> |function key 10 |
2011
+---------------------------------+
2012
2013
2014
key does not need to be enclosed in quotes unless it contains a space (???) or
2015
semi-colon (?;?).
1816
2016
1817
2017
function specifies which action to take when key is pressed. For a complete
1818
list of functions, see the reference. The special function noop unbinds the
2018
list of functions, see the reference. The special function <noop> unbinds the
1819
2019
specified key sequence.
1820
2020
1821
5. Defining aliases for character sets
1822
1823
1824
Usage: charset-hook alias charset
1825
Usage: iconv-hook charset local-charset
2021
6. Defining aliases for character sets
2022
2023
Usage:
2024
2025
charset-hook alias charset
2026
2027
iconv-hook charset local-charset
1826
2028
1827
2029
The charset-hook command defines an alias for a character set. This is useful
1828
2030
to properly display messages which are tagged with a character set name not
1832
2034
is helpful when your systems character conversion library insists on using
1833
2035
strange, system-specific names for character sets.
1834
2036
1835
6. Setting variables based upon mailbox
1836
1837
Usage: folder-hook [!]regexpcommand
2037
7. Setting variables based upon mailbox
2038
2039
Usage:
2040
2041
folder-hook [!]regexp command
1838
2042
1839
2043
It is often desirable to change settings based on which mailbox you are
1840
2044
reading. The folder-hook command provides a method by which you can execute any
1842
2046
mailboxes to execute command before loading. If a mailbox matches multiple
1843
2047
folder-hook's, they are executed in the order given in the muttrc.
1844
2048
1845
Note: if you use the ``!'' shortcut for $spoolfile at the beginning of the
1846
pattern, you must place it inside of double or single quotes in order to
1847
distinguish it from the logical not operator for the expression.
1848
1849
Note that the settings are not restored when you leave the mailbox. For
1850
example, a command action to perform is to change the sorting method based upon
1851
the mailbox being read:
2049
Note
2050
2051
If you use the ?!? shortcut for $spoolfile at the beginning of the pattern, you
2052
must place it inside of double or single quotes in order to distinguish it from
2053
the logical not operator for the expression.
2054
2055
Note
2056
2057
Settings are not restored when you leave the mailbox. For example, a command
2058
action to perform is to change the sorting method based upon the mailbox being
2059
read:
1852
2060
1853
2061
folder-hook mutt set sort=threads
1854
2062
1855
2063
However, the sorting method is not restored to its previous value when reading
1856
a different mailbox. To specify a default command, use the pattern ``.'':
2064
a different mailbox. To specify a default command, use the pattern ?.? before
2065
other folder-hooks adjusting a value on a per-folder basis because folder-hooks
2066
are evaluated in the order given in the configuration file. The following
2067
example will set the sort variable to date-sent for all folders but to threads
2068
for all folders containing ?mutt? in their name.
2069
2070
Example 3.7. Setting sort method based on mailbox name
1857
2071
1858
2072
folder-hook . set sort=date-sent
1859
1860
7. Keyboard macros
1861
1862
Usage: macromenukeysequence [ description ]
2073
folder-hook mutt set sort=threads
2074
2075
2076
8. Keyboard macros
2077
2078
Usage:
2079
2080
macro menu key sequence [ description ]
1863
2081
1864
2082
Macros are useful when you would like a single key to perform a series of
1865
2083
actions. When you press key in menu menu, Mutt will behave as if you had typed
1866
2084
sequence. So if you have a common sequence of commands you type, you can create
1867
a macro to execute those commands with a single key.
1868
1869
menu is the map which the macro will be bound. Multiple maps may be specified
1870
by separating multiple menu arguments by commas. Whitespace may not be used in
1871
between the menu arguments and the commas separating them.
1872
1873
key and sequence are expanded by the same rules as the key bindings. There are
1874
some additions however. The first is that control characters in sequence can
1875
also be specified as ^x. In order to get a caret (`^'') you need to use ^^.
1876
Secondly, to specify a certain key such as up or to invoke a function directly,
1877
you can use the format <key name> and <function name>. For a listing of key
1878
names see the section on key bindings. Functions are listed in the reference.
2085
a macro to execute those commands with a single key or fewer keys.
2086
2087
menu is the map which the macro will be bound in. Multiple maps may be
2088
specified by separating multiple menu arguments by commas. Whitespace may not
2089
be used in between the menu arguments and the commas separating them.
2090
2091
key and sequence are expanded by the same rules as the key bindings with some
2092
additions. The first is that control characters in sequence can also be
2093
specified as ^x. In order to get a caret (?^?) you need to use ^^. Secondly, to
2094
specify a certain key such as up or to invoke a function directly, you can use
2095
the format <key name> and <function name>. For a listing of key names see the
2096
section on key bindings. Functions are listed in the reference.
1879
2097
1880
2098
The advantage with using function names directly is that the macros will work
1881
2099
regardless of the current key bindings, so they are not dependent on the user
1886
2104
Optionally you can specify a descriptive text after sequence, which is shown in
1887
2105
the help screens.
1888
2106
1889
Note: Macro definitions (if any) listed in the help screen(s), are silently
1890
truncated at the screen width, and are not wrapped.
1891
1892
8. Using color and mono video attributes
1893
1894
1895
Usage: color object foreground background [ regexp ]
1896
Usage: color index foreground background pattern
1897
Usage: uncolor index pattern [ pattern ... ]
2107
Note
2108
2109
Macro definitions (if any) listed in the help screen(s), are silently truncated
2110
at the screen width, and are not wrapped.
2111
2112
9. Using color and mono video attributes
2113
2114
Usage:
2115
2116
color object foreground background
2117
2118
color { header | body } foreground background regexp
2119
2120
color index foreground background pattern
2121
2122
uncolor index { * | pattern ... }
1898
2123
1899
2124
If your terminal supports color, you can spice up Mutt by creating your own
1900
2125
color scheme. To define the color of an object (type of information), you must
1901
2126
specify both a foreground color and a background color (it is not possible to
1902
2127
only specify one or the other).
1903
2128
2129
header and body match regexp in the header/body of a message, index matches
2130
pattern (see Section 2, ?Patterns: Searching, Limiting and Tagging?) in the
2131
message index.
2132
1904
2133
object can be one of:
1905
2134
1906
● attachment
1907
1908
● body (match regexp in the body of messages)
1909
1910
● bold (hiliting bold patterns in the body of messages)
1911
1912
● error (error messages printed by Mutt)
1913
1914
● header (match regexp in the message header)
1915
1916
● hdrdefault (default color of the message header in the pager)
1917
1918
● index (match pattern in the message index)
1919
1920
● indicator (arrow or bar used to indicate the current item in a menu)
1921
1922
● markers (the ``+'' markers at the beginning of wrapped lines in the pager)
1923
1924
● message (informational messages)
1925
1926
● normal
1927
1928
● quoted (text matching $quote_regexp in the body of a message)
1929
1930
● quoted1, quoted2, ..., quotedN (higher levels of quoting)
1931
1932
● search (hiliting of words in the pager)
1933
1934
● signature
1935
1936
● status (mode lines used to display info about the mailbox or message)
1937
1938
● tilde (the ``~'' used to pad blank lines in the pager)
1939
1940
● tree (thread tree drawn in the message index and attachment menu)
1941
1942
● underline (hiliting underlined patterns in the body of messages)
2135
* attachment
2136
2137
* bold (hiliting bold patterns in the body of messages)
2138
2139
* error (error messages printed by Mutt)
2140
2141
* hdrdefault (default color of the message header in the pager)
2142
2143
* indicator (arrow or bar used to indicate the current item in a menu)
2144
2145
* markers (the ?+? markers at the beginning of wrapped lines in the pager)
2146
2147
* message (informational messages)
2148
2149
* normal
2150
2151
* quoted (text matching $quote_regexp in the body of a message)
2152
2153
* quoted1, quoted2, ..., quotedN (higher levels of quoting)
2154
2155
* search (hiliting of words in the pager)
2156
2157
* signature
2158
2159
* status (mode lines used to display info about the mailbox or message)
2160
2161
* tilde (the ??? used to pad blank lines in the pager)
2162
2163
* tree (thread tree drawn in the message index and attachment menu)
2164
2165
* underline (hiliting underlined patterns in the body of messages)
1943
2166
1944
2167
foreground and background can be one of the following:
1945
2168
1946
● white
1947
1948
● black
1949
1950
● green
1951
1952
● magenta
1953
1954
● blue
1955
1956
● cyan
1957
1958
● yellow
1959
1960
● red
1961
1962
● default
1963
1964
● colorx
2169
* white
2170
2171
* black
2172
2173
* green
2174
2175
* magenta
2176
2177
* blue
2178
2179
* cyan
2180
2181
* yellow
2182
2183
* red
2184
2185
* default
2186
2187
* colorx
1965
2188
1966
2189
foreground can optionally be prefixed with the keyword bright to make the
1967
2190
foreground color boldfaced (e.g., brightred).
1975
2198
set COLORFGBG="green;black"
1976
2199
export COLORFGBG
1977
2200
1978
Note: The S-Lang library requires you to use the lightgray and brown keywords
1979
instead of white and yellow when setting this variable.
1980
1981
Note: The uncolor command can be applied to the index object only. It removes
1982
entries from the list. You must specify the same pattern specified in the color
1983
command for it to be removed. The pattern ``*'' is a special token which means
1984
to clear the color index list of all entries.
1985
1986
Mutt also recognizes the keywords color0, color1, ..., colorN-1 (N being the
2201
Note
2202
2203
The S-Lang library requires you to use the lightgray and brown keywords instead
2204
of white and yellow when setting this variable.
2205
2206
Note
2207
2208
The uncolor command can be applied to the index object only. It removes entries
2209
from the list. You must specify the same pattern specified in the color command
2210
for it to be removed. The pattern ?*? is a special token which means to clear
2211
the color index list of all entries.
2212
2213
Mutt also recognizes the keywords color0, color1, ?, colorN-1 (N being the
1987
2214
number of colors supported by your terminal). This is useful when you remap the
1988
2215
colors for your display (for example by changing the color associated with
1989
2216
color2 for your xterm), since color names may then lose their normal meaning.
1990
2217
1991
2218
If your terminal does not support color, it is still possible change the video
1992
attributes through the use of the ``mono'' command:
1993
1994
1995
Usage: mono <object> <attribute> [ regexp ]
1996
Usage: mono index attribute pattern
1997
Usage: unmono index pattern [ pattern ... ]
1998
1999
where attribute is one of the following:
2000
2001
● none
2002
2003
● bold
2004
2005
● underline
2006
2007
● reverse
2008
2009
● standout
2010
2011
9. Ignoring (weeding) unwanted message headers
2012
2013
Usage: [un]ignorepattern [ pattern ... ]
2219
attributes through the use of the ?mono? command:
2220
2221
Usage:
2222
2223
mono object attribute
2224
2225
mono { header | body } attribute regexp
2226
2227
mono index attribute pattern
2228
2229
unmono index { * | pattern ... }
2230
2231
For object, see the color command. attribute can be one of the following:
2232
2233
* none
2234
2235
* bold
2236
2237
* underline
2238
2239
* reverse
2240
2241
* standout
2242
2243
10. Message header display
2244
2245
Usage:
2246
2247
ignore pattern [ pattern ...]
2248
2249
unignore { * | pattern ... }
2014
2250
2015
2251
Messages often have many header fields added by automatic processing systems,
2016
2252
or which may not seem useful to display on the screen. This command allows you
2017
to specify header fields which you don't normally want to see.
2018
2019
You do not need to specify the full header field name. For example, ``ignore
2020
content-'' will ignore all header fields that begin with the pattern
2021
``content-''. ``ignore *'' will ignore all headers.
2022
2023
To remove a previously added token from the list, use the ``unignore'' command.
2024
The ``unignore'' command will make Mutt display headers with the given pattern.
2025
For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''.
2026
2027
``unignore *'' will remove all tokens from the ignore list.
2253
to specify header fields which you don't normally want to see in the pager.
2254
2255
You do not need to specify the full header field name. For example, ?ignore
2256
content-? will ignore all header fields that begin with the pattern ?content-?.
2257
?ignore *? will ignore all headers.
2258
2259
To remove a previously added token from the list, use the ?unignore? command.
2260
The ?unignore? command will make Mutt display headers with the given pattern.
2261
For example, if you do ?ignore x-? it is possible to ?unignore x-mailer?.
2262
2263
?unignore *? will remove all tokens from the ignore list.
2028
2264
2029
2265
For example:
2030
2266
2267
Example 3.8. Header weeding
2268
2031
2269
# Sven's draconian header weeding
2032
2270
ignore *
2033
2271
unignore from date subject to cc
2034
2272
unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
2035
2273
unignore posted-to:
2036
2274
2037
10. Alternative addresses
2038
2039
Usage: [un]alternates [ -groupname [ ... ] ] regexp [ regexp ... ]
2275
2276
Usage:
2277
2278
hdr_order header [ header ...]
2279
2280
unhdr_order { * | header ... }
2281
2282
With the hdr_order command you can specify an order in which mutt will attempt
2283
to present these headers to you when viewing messages.
2284
2285
?unhdr_order *? will clear all previous headers from the order list, thus
2286
removing the header order effects set by the system-wide startup file.
2287
2288
Example 3.9. Configuring header display order
2289
2290
hdr_order From Date: From: To: Cc: Subject:
2291
2292
2293
11. Alternative addresses
2294
2295
Usage:
2296
2297
alternates [ -group name ...] regexp [ regexp ...]
2298
2299
unalternates [ -group name ...] { * | regexp ... }
2040
2300
2041
2301
With various functions, mutt will treat messages differently, depending on
2042
2302
whether you sent them or whether you received them from someone else. For
2057
2317
2058
2318
alternates user@example
2059
2319
2060
mutt will consider ``some-user@example'' as being your address, too which may
2061
not be desired. As a solution, in such cases addresses should be specified as:
2320
mutt will consider ?some-user@example? as being your address, too which may not
2321
be desired. As a solution, in such cases addresses should be specified as:
2062
2322
2063
2323
alternates '^user@example$'
2064
2324
2073
2333
To remove a regular expression from the alternates list, use the unalternates
2074
2334
command with exactly the same regexp. Likewise, if the regexp for an alternates
2075
2335
command matches an entry on the unalternates list, that unalternates entry will
2076
be removed. If the regexp for unalternates is ``*'', all entries on alternates
2336
be removed. If the regexp for unalternates is ?*?, all entries on alternates
2077
2337
will be removed.
2078
2338
2079
11. Mailing lists
2080
2081
2082
Usage: [un]lists [ -group name [ ... ] ] regexp [ regexp ... ]
2083
Usage: [un]subscribe [ -group name [ ... ] ] regexp [ regexp ... ]
2339
12. Mailing lists
2340
2341
Usage:
2342
2343
lists [ -group name ...] regexp [ regexp ...]
2344
2345
unlists [ -group name ...] { * | regexp ... }
2346
2347
subscribe [ -group name ...] regexp [ regexp ...]
2348
2349
unsubscribe [ -group name ...] { * | regexp ... }
2084
2350
2085
2351
Mutt has a few nice features for handling mailing lists. In order to take
2086
2352
advantage of them, you must specify which addresses belong to mailing lists,
2087
2353
and which mailing lists you are subscribed to. Once you have done this, the
2088
list-reply function will work for all known lists. Additionally, when you send
2089
a message to a subscribed list, mutt will add a Mail-Followup-To header to tell
2090
other users' mail user agents not to send copies of replies to your personal
2091
address. Note that the Mail-Followup-To header is a non-standard extension
2092
which is not supported by all mail user agents. Adding it is not bullet-proof
2093
against receiving personal CCs of list messages. Also note that the generation
2094
of the Mail-Followup-To header is controlled by the $followup_to configuration
2354
<list-reply> function will work for all known lists. Additionally, when you
2355
send a message to a subscribed list, mutt will add a Mail-Followup-To header to
2356
tell other users' mail user agents not to send copies of replies to your
2357
personal address.
2358
2359
Note
2360
2361
The Mail-Followup-To header is a non-standard extension which is not supported
2362
by all mail user agents. Adding it is not bullet-proof against receiving
2363
personal CCs of list messages. Also note that the generation of the
2364
Mail-Followup-To header is controlled by the $followup_to configuration
2095
2365
variable.
2096
2366
2097
2367
More precisely, Mutt maintains lists of patterns for the addresses of known and
2098
2368
subscribed mailing lists. Every subscribed mailing list is known. To mark a
2099
mailing list as known, use the ``lists'' command. To mark it as subscribed, use
2100
``subscribe''.
2369
mailing list as known, use the ?lists? command. To mark it as subscribed, use
2370
?subscribe?.
2101
2371
2102
2372
You can use regular expressions with both commands. To mark all messages sent
2103
2373
to a specific bug report's address on mutt's bug tracking system as list mail,
2104
for instance, you could say ``subscribe [0-9]*@bugs.guug.de''. Often, it's
2374
for instance, you could say ?subscribe [0-9]*@bugs.guug.de?. Often, it's
2105
2375
sufficient to just give a portion of the list's e-mail address.
2106
2376
2107
2377
Specify as much of the address as you need to to remove ambiguity. For example,
2108
2378
if you've subscribed to the Mutt mailing list, you will receive mail addressed
2109
2379
to mutt-users@mutt.org. So, to tell Mutt that this is a mailing list, you could
2110
add ``lists mutt-users@'' to your initialization file. To tell mutt that you
2111
are subscribed to it, add ``subscribe mutt-users'' to your initialization file
2380
add ?lists mutt-users@? to your initialization file. To tell mutt that you are
2381
subscribed to it, add ?subscribe mutt-users? to your initialization file
2112
2382
instead. If you also happen to get mail from someone whose address is
2113
mutt-users@example.com, you could use ``lists ^mutt-users@mutt\\.org$'' or
2114
``subscribe ^mutt-users@mutt\\.org$'' to match only mail from the actual list.
2383
mutt-users@example.com, you could use ?lists ^mutt-users@mutt\\.org$? or
2384
?subscribe ^mutt-users@mutt\\.org$? to match only mail from the actual list.
2115
2385
2116
2386
The -group flag adds all of the subsequent regular expressions to the named
2117
2387
group.
2118
2388
2119
The ``unlists'' command is used to remove a token from the list of known and
2120
subscribed mailing-lists. Use ``unlists *'' to remove all tokens.
2389
The ?unlists? command is used to remove a token from the list of known and
2390
subscribed mailing-lists. Use ?unlists *? to remove all tokens.
2121
2391
2122
2392
To remove a mailing list from the list of subscribed mailing lists, but keep it
2123
on the list of known mailing lists, use ``unsubscribe''.
2124
2125
12. Using Multiple spool mailboxes
2126
2127
Usage: mbox-hook [!]patternmailbox
2393
on the list of known mailing lists, use ?unsubscribe?.
2394
2395
13. Using Multiple spool mailboxes
2396
2397
Usage:
2398
2399
mbox-hook [!]pattern mailbox
2128
2400
2129
2401
This command is used to move read messages from a specified mailbox to a
2130
2402
different mailbox automatically when you quit or change folders. pattern is a
2131
regular expression specifying the mailbox to treat as a ``spool'' mailbox and
2403
regular expression specifying the mailbox to treat as a ?spool? mailbox and
2132
2404
mailbox specifies where mail should be saved when read.
2133
2405
2134
2406
Unlike some of the other hook commands, only the first matching pattern is used
2135
2407
(it is not possible to save read mail in more than a single mailbox).
2136
2408
2137
13. Monitoring incoming mail
2138
2139
Usage: [un]mailboxesfolder [ folder ... ]
2409
14. Monitoring incoming mail
2410
2411
Usage:
2412
2413
mailboxes mailbox [ mailbox ...]
2414
2415
unmailboxes { * | mailbox ... }
2140
2416
2141
2417
This command specifies folders which can receive mail and which will be checked
2142
for new messages. By default, the main menu status bar displays how many of
2143
these folders have new messages.
2418
for new messages periodically.
2144
2419
2145
2420
folder can either be a local file or directory (Mbox/Mmdf or Maildir/Mh). If
2146
2421
Mutt was built with POP and/or IMAP support, folder can also be a POP/IMAP
2147
folder URL. The URL syntax is described in Section 1.2, "URL syntax", POP and
2148
IMAP are described in Section 3, "POP3 Support" and Section 4, "IMAP Support"
2422
folder URL. The URL syntax is described in Section 1.2, ?URL syntax?, POP and
2423
IMAP are described in Section 3, ?POP3 Support? and Section 4, ?IMAP Support?
2149
2424
respectively.
2150
2425
2151
When changing folders, pressing space will cycle through folders with new mail.
2152
2153
Pressing TAB in the directory browser will bring up a menu showing the files
2154
specified by the mailboxes command, and indicate which contain new messages.
2155
Mutt will automatically enter this mode when invoked from the command line with
2156
the -y option.
2157
2158
The ``unmailboxes'' command is used to remove a token from the list of folders
2159
which receive mail. Use ``unmailboxes *'' to remove all tokens.
2160
2161
Note: the folders in the mailboxes command are resolved when the command is
2162
executed, so if these names contain shortcut characters (such as ``='' and ``!
2163
''), any variable definition that affect these characters (like $folder and
2164
$spoolfile) should be executed before the mailboxes command. If none of these
2165
shorcuts are used, a local path should be absolute as otherwise mutt tries to
2166
find it within the current working directory from where mutt was started which
2167
may not always be desired.
2168
2169
For local folders, new mail is detected by comparing access and/or modification
2170
times of files and folders. The interval in which Mutt checks for new mail is
2171
defined by $mail_check.
2172
2173
Special care is required with Mbox and Mmdf folders as Mutt assumes such a
2174
folder has new mail if it wasn't accessed after it was last modified. Utilities
2175
like biff or frm or any other program which accesses the mailbox might cause
2176
Mutt to never detect new mail for that mailbox if they do not properly reset
2177
the access time. Backup tools are another common reason for updated access
2178
times.
2179
2180
14. User defined headers
2181
2182
Usage: my_hdrstringunmy_hdrfield [ field ... ]
2183
2184
The ``my_hdr'' command allows you to create your own header fields which will
2185
be added to every message you send.
2186
2187
For example, if you would like to add an ``Organization:'' header field to all
2188
of your outgoing messages, you can put the command
2189
2190
"my_hdr Organization: A Really Big Company, Anytown, USA"
2426
Mutt provides a number of advanced features for handling (possibly many)
2427
folders and new mail within them, please refer to Section 9, ?Handling multiple
2428
folders? for details (including in what situations and how often Mutt checks
2429
for new mail).
2430
2431
The ?unmailboxes? command is used to remove a token from the list of folders
2432
which receive mail. Use ?unmailboxes *? to remove all tokens.
2433
2434
Note
2435
2436
The folders in the mailboxes command are resolved when the command is executed,
2437
so if these names contain shortcut characters (such as ?=? and ?!?), any
2438
variable definition that affects these characters (like $folder and $spoolfile)
2439
should be set before the mailboxes command. If none of these shorcuts are used,
2440
a local path should be absolute as otherwise mutt tries to find it relative to
2441
the directory from where mutt was started which may not always be desired.
2442
2443
For Mbox and Mmdf folders, new mail is detected by comparing access and/or
2444
modification times of files: Mutt assumes a folder has new mail if it wasn't
2445
accessed after it was last modified. Utilities like biff or frm or any other
2446
program which accesses the mailbox might cause Mutt to never detect new mail
2447
for that mailbox if they do not properly reset the access time. Other possible
2448
causes of Mutt not detecting new mail in these folders are backup tools
2449
(updating access times) or filesystems mounted without access time update
2450
support.
2451
2452
In cases where new mail detection for Mbox or Mmdf folders appears to be
2453
unreliable, the $check_mbox_size option can be used to make Mutt track and
2454
consult file sizes for new mail detection instead.
2455
2456
15. User defined headers
2457
2458
Usage:
2459
2460
my_hdr string
2461
2462
unmy_hdr { * | field ... }
2463
2464
The my_hdr command allows you to create your own header fields which will be
2465
added to every message you send.
2466
2467
For example, if you would like to add an ?Organization:? header field to all of
2468
your outgoing messages, you can put the command
2469
2470
Example 3.10. Defining custom headers
2471
2472
my_hdr Organization: A Really Big Company, Anytown, USA
2473
2191
2474
2192
2475
in your .muttrc.
2193
2476
2194
Note: space characters are not allowed between the keyword and the colon
2195
(``:''). The standard for electronic mail (RFC822) says that space is illegal
2196
there, so Mutt enforces the rule.
2477
Note
2478
2479
Space characters are not allowed between the keyword and the colon (?:?). The
2480
standard for electronic mail (RFC2822) says that space is illegal there, so
2481
Mutt enforces the rule.
2197
2482
2198
2483
If you would like to add a header field to a single message, you should either
2199
set the $edit_headers variable, or use the edit-headers function (default:
2200
``E'') in the send-menu so that you can edit the header of your message along
2484
set the $edit_headers variable, or use the <edit-headers> function (default:
2485
?E?) in the compose menu so that you can edit the header of your message along
2201
2486
with the body.
2202
2487
2203
To remove user defined header fields, use the ``unmy_hdr'' command. You may
2204
specify an asterisk (``*'') to remove all header fields, or the fields to
2205
remove. For example, to remove all ``To'' and ``Cc'' header fields, you could
2206
use:
2207
2208
"unmy_hdr to cc"
2209
2210
15. Defining the order of headers when viewing messages
2211
2212
Usage: hdr_orderheader1header2header3
2213
2214
With this command, you can specify an order in which mutt will attempt to
2215
present headers to you when viewing messages.
2216
2217
``unhdr_order *'' will clear all previous headers from the order list, thus
2218
removing the header order effects set by the system-wide startup file.
2219
2220
hdr_order From Date: From: To: Cc: Subject:
2488
To remove user defined header fields, use the unmy_hdr command. You may specify
2489
an asterisk (?*?) to remove all header fields, or the fields to remove. For
2490
example, to remove all ?To? and ?Cc? header fields, you could use:
2491
2492
unmy_hdr to cc
2221
2493
2222
2494
16. Specify default save mailbox
2223
2495
2224
Usage: save-hook [!]patternmailbox
2496
Usage:
2497
2498
save-hook [!]pattern mailbox
2225
2499
2226
2500
This command is used to override the default mailbox used when saving messages.
2227
2501
mailbox will be used as the default if the message matches pattern, see Message
2232
2506
2233
2507
Examples:
2234
2508
2509
Example 3.11. Using %-expandos in save-hook
2510
2235
2511
# default: save all to ~/Mail/<author name>
2236
2512
save-hook . ~/Mail/%F
2237
# save from me@turing.cs.hmc.edu/me@cs.hmc.edu to $folder/elinks
2513
2514
# save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins
2238
2515
save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
2516
2239
2517
# save from aol.com to $folder/spam
2240
2518
save-hook aol\\.com$ +spam
2241
2519
2520
2242
2521
Also see the fcc-save-hook command.
2243
2522
2244
2523
17. Specify default Fcc: mailbox when composing
2245
2524
2246
Usage: fcc-hook [!]patternmailbox
2525
Usage:
2526
2527
fcc-hook [!]pattern mailbox
2247
2528
2248
2529
This command is used to save outgoing mail in a mailbox other than $record.
2249
2530
Mutt searches the initial list of message recipients for the first matching
2262
2543
2263
2544
18. Specify default save filename and default Fcc: mailbox at once
2264
2545
2265
Usage: fcc-save-hook [!]patternmailbox
2546
Usage:
2547
2548
fcc-save-hook [!]pattern mailbox
2266
2549
2267
2550
This command is a shortcut, equivalent to doing both a fcc-hook and a save-hook
2268
2551
with its arguments, including %-expansion on mailbox according to $index_format
2270
2553
2271
2554
19. Change settings based upon message recipients
2272
2555
2273
2274
Usage: reply-hook [!]pattern command
2275
Usage: send-hook [!]pattern command
2276
Usage: send2-hook [!]pattern command
2556
Usage:
2557
2558
reply-hook [!]pattern command
2559
2560
send-hook [!]pattern command
2561
2562
send2-hook [!]pattern command
2277
2563
2278
2564
These commands can be used to execute arbitrary configuration commands based
2279
upon recipients of the message. pattern is a regular expression matching the
2280
desired address. command is executed when regexp matches recipients of the
2281
message.
2565
upon recipients of the message. pattern is used to match the message, see
2566
Message Matching in Hooks for details. command is executed when pattern
2567
matches.
2282
2568
2283
reply-hook is matched against the message you are replyingto, instead of the
2569
reply-hook is matched against the message you are replying to, instead of the
2284
2570
message you are sending. send-hook is matched against all messages, both new
2285
and replies. Note:reply-hooks are matched before the send-hook, regardless of
2286
the order specified in the user's configuration file.
2571
and replies.
2572
2573
Note
2574
2575
reply-hooks are matched before the send-hook, regardless of the order specified
2576
in the user's configuration file.
2287
2577
2288
2578
send2-hook is matched every time a message is changed, either by editing it, or
2289
2579
by using the compose menu to change its recipients or subject. send2-hook is
2294
2584
are executed in the order they are specified in the muttrc (for that type of
2295
2585
hook).
2296
2586
2297
See Message Matching in Hooks for information on the exact format of pattern.
2298
2299
2587
Example: send-hook mutt "set mime_forward signature=''"
2300
2588
2301
2589
Another typical use for this command is to change the values of the
2302
2590
$attribution, $signature and $locale variables in order to change the language
2303
2591
of the attributions and signatures based upon the recipients.
2304
2592
2305
Note: the send-hook's are only executed ONCE after getting the initial list of
2306
recipients. Adding a recipient after replying or editing the message will NOT
2593
Note
2594
2595
send-hook's are only executed once after getting the initial list of
2596
recipients. Adding a recipient after replying or editing the message will not
2307
2597
cause any send-hook to be executed. Also note that my_hdr commands which modify
2308
2598
recipient headers, or the message's subject, don't have any effect on the
2309
2599
current message when executed from a send-hook.
2310
2600
2311
2601
20. Change settings before formatting a message
2312
2602
2313
Usage: message-hook [!]patterncommand
2603
Usage:
2604
2605
message-hook [!]pattern command
2314
2606
2315
2607
This command can be used to execute arbitrary configuration commands before
2316
2608
viewing or formatting a message based upon information about the message.
2327
2619
2328
2620
21. Choosing the cryptographic key of the recipient
2329
2621
2330
Usage: crypt-hookpatternkeyid
2331
2332
When encrypting messages with PGP or OpenSSL, you may want to associate a
2622
Usage:
2623
2624
crypt-hook pattern keyid
2625
2626
When encrypting messages with PGP/GnuPG or OpenSSL, you may want to associate a
2333
2627
certain key with a given e-mail address automatically, either because the
2334
2628
recipient's public key can't be deduced from the destination address, or
2335
2629
because, for some reasons, you need to override the key Mutt would normally
2336
2630
use. The crypt-hook command provides a method by which you can specify the ID
2337
2631
of the public key to be used when encrypting messages to a certain recipient.
2338
2632
2339
The meaning of "key id" is to be taken broadly in this context: You can either
2340
put a numerical key ID here, an e-mail address, or even just a real name.
2633
The meaning of keyid is to be taken broadly in this context: You can either put
2634
a numerical key ID here, an e-mail address, or even just a real name.
2341
2635
2342
2636
22. Adding key sequences to the keyboard buffer
2343
2637
2344
Usage: pushstring
2638
Usage:
2639
2640
push string
2345
2641
2346
2642
This command adds the named string to the keyboard buffer. The string may
2347
2643
contain control characters, key names and function names like the sequence
2350
2646
following command will automatically collapse all threads when entering a
2351
2647
folder:
2352
2648
2649
Example 3.12. Embedding push in folder-hook
2650
2353
2651
folder-hook . 'push <collapse-all>'
2354
2652
2653
2355
2654
23. Executing functions
2356
2655
2357
Usage: execfunction [ function ... ]
2656
Usage:
2657
2658
exec function [ function ...]
2358
2659
2359
2660
This command can be used to execute any function. Functions are listed in the
2360
function reference. ``exec function'' is equivalent to ``push <function>''.
2661
function reference. ?exec function? is equivalent to ?push <function>?.
2361
2662
2362
2663
24. Message Scoring
2363
2664
2364
2365
Usage: score pattern value
2366
Usage: unscore pattern [ pattern ... ]
2665
Usage:
2666
2667
score pattern value
2668
2669
unscore { * | pattern ... }
2367
2670
2368
2671
The score commands adds value to a message's score if pattern matches it.
2369
2672
pattern is a string in the format described in the patterns section (note: For
2370
2673
efficiency reasons, patterns which scan information not available in the index,
2371
such as ~b, ~B or ~h, may not be used). value is a positive or negative
2674
such as ?b, ?B or ?h, may not be used). value is a positive or negative
2372
2675
integer. A message's final score is the sum total of all matching score
2373
2676
entries. However, you may optionally prefix value with an equal sign (=) to
2374
2677
cause evaluation to stop at a particular entry if there is a match. Negative
2376
2679
2377
2680
The unscore command removes score entries from the list. You must specify the
2378
2681
same pattern specified in the score command for it to be removed. The pattern
2379
``*'' is a special token which means to clear the list of all score entries.
2682
?*? is a special token which means to clear the list of all score entries.
2380
2683
2381
2684
25. Spam detection
2382
2685
2383
2384
Usage: spam pattern format
2385
Usage: nospam pattern
2686
Usage:
2687
2688
spam pattern format
2689
2690
nospam { * | pattern }
2386
2691
2387
2692
Mutt has generalized support for external spam-scoring filters. By defining
2388
2693
your spam patterns with the spam and nospam commands, you can limit, search,
2394
2699
Your first step is to define your external filter's spam patterns using the
2395
2700
spam command. pattern should be a regular expression that matches a header in a
2396
2701
mail message. If any message in the mailbox matches this regular expression, it
2397
will receive a ``spam tag'' or ``spam attribute'' (unless it also matches a
2398
nospam pattern -- see below.) The appearance of this attribute is entirely up
2399
to you, and is governed by the format parameter. format can be any static text,
2400
but it also can include back-references from the pattern expression. (A regular
2401
expression ``back-reference'' refers to a sub-expression contained within
2702
will receive a ?spam tag? or ?spam attribute? (unless it also matches a nospam
2703
pattern -- see below.) The appearance of this attribute is entirely up to you,
2704
and is governed by the format parameter. format can be any static text, but it
2705
also can include back-references from the pattern expression. (A regular
2706
expression ?back-reference? refers to a sub-expression contained within
2402
2707
parentheses.) %1 is replaced with the first back-reference in the regex, %2
2403
2708
with the second, etc.
2404
2709
2411
2716
For example, suppose I use DCC, SpamAssassin, and PureMessage. I might define
2412
2717
these spam settings:
2413
2718
2719
Example 3.13. Configuring spam detection
2720
2414
2721
spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
2415
2722
spam "X-Spam-Status: Yes" "90+/SA"
2416
2723
spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
2417
2724
set spam_separator=", "
2418
2725
2419
If I then received a message that DCC registered with ``many'' hits under the
2420
``Fuz2'' checksum, and that PureMessage registered with a 97% probability of
2726
2727
If I then received a message that DCC registered with ?many? hits under the
2728
?Fuz2? checksum, and that PureMessage registered with a 97% probability of
2421
2729
being spam, that message's spam tag would read 90+/DCC-Fuz2, 97/PM. (The four
2422
characters before ``=many'' in a DCC report indicate the checksum used -- in
2423
this case, ``Fuz2''.)
2730
characters before ?=many? in a DCC report indicate the checksum used -- in this
2731
case, ?Fuz2?.)
2424
2732
2425
2733
If the $spam_separator variable is unset, then each spam pattern match
2426
2734
supersedes the previous one. Instead of getting joined format strings, you'll
2427
2735
get only the last one to match.
2428
2736
2429
2737
The spam tag is what will be displayed in the index when you use %H in the
2430
$index_format variable. It's also the string that the ~H pattern-matching
2431
expression matches against for search and limit functions. And it's what
2738
$index_format variable. It's also the string that the ?H pattern-matching
2739
expression matches against for <search> and <limit> functions. And it's what
2432
2740
sorting by spam attribute will use as a sort key.
2433
2741
2434
2742
That's a pretty complicated example, and most people's actual environments will
2441
2749
in value. (This is like UNIX's sort -n.) A message with no spam attributes at
2442
2750
all -- that is, one that didn't match any of your spam patterns -- is sorted at
2443
2751
lowest priority. Numbers are sorted next, beginning with 0 and ranging upward.
2444
Finally, non-numeric strings are sorted, with ``a'' taking lower priority than
2445
``z''. Clearly, in general, sorting by spam tags is most effective when you can
2752
Finally, non-numeric strings are sorted, with ?a? taking lower priority than
2753
?z?. Clearly, in general, sorting by spam tags is most effective when you can
2446
2754
coerce your filter to give you a raw number. But in case you can't, mutt can
2447
2755
still do something useful.
2448
2756
2455
2763
existing spam list entry, the effect will be to remove the entry from the spam
2456
2764
list, instead of adding an exception. Likewise, if the pattern for a spam
2457
2765
command matches an entry on the nospam list, that nospam entry will be removed.
2458
If the pattern for nospam is ``*'', all entries on both lists will be removed.
2766
If the pattern for nospam is ?*?, all entries on both lists will be removed.
2459
2767
This might be the default action if you use spam and nospam in conjunction with
2460
2768
a folder-hook.
2461
2769
2471
2779
2472
2780
The following commands are available to manipulate and query variables:
2473
2781
2474
2475
Usage: set [no|inv]variable[=value] [ variable ... ]
2476
Usage: toggle variable [variable ... ]
2477
Usage: unset variable [variable ... ]
2478
Usage: reset variable [variable ... ]
2782
Usage:
2783
2784
set { [ no | inv ] variable | variable=value } [...]
2785
2786
toggle variable [ variable ...]
2787
2788
unset variable [ variable ...]
2789
2790
reset variable [ variable ...]
2479
2791
2480
2792
This command is used to set (and unset) configuration variables. There are four
2481
2793
basic types of variables: boolean, number, string and quadoption. boolean
2482
2794
variables can be set (true) or unset (false). number variables can be assigned
2483
a positive integer value.
2484
2485
string variables consist of any number of printable characters. strings must be
2486
enclosed in quotes if they contain spaces or tabs. You may also use the ``C''
2487
escape sequences \n and \t for newline and tab, respectively.
2488
2489
quadoption variables are used to control whether or not to be prompted for
2490
certain actions, or to specify a default action. A value of yes will cause the
2491
action to be carried out automatically as if you had answered yes to the
2492
question. Similarly, a value of no will cause the action to be carried out as
2493
if you had answered ``no.'' A value of ask-yes will cause a prompt with a
2494
default answer of ``yes'' and ask-no will provide a default answer of ``no.''
2495
2496
Prefixing a variable with ``no'' will unset it. Example: set noaskbcc.
2795
a positive integer value. string variables consist of any number of printable
2796
characters and must be enclosed in quotes if they contain spaces or tabs. You
2797
may also use the escape sequences ?\n? and ?\t? for newline and tab,
2798
respectively. quadoption variables are used to control whether or not to be
2799
prompted for certain actions, or to specify a default action. A value of yes
2800
will cause the action to be carried out automatically as if you had answered
2801
yes to the question. Similarly, a value of no will cause the action to be
2802
carried out as if you had answered ?no.? A value of ask-yes will cause a prompt
2803
with a default answer of ?yes? and ask-no will provide a default answer of
2804
?no.?
2805
2806
Prefixing a variable with ?no? will unset it. Example: set noaskbcc.
2497
2807
2498
2808
For boolean variables, you may optionally prefix the variable name with inv to
2499
2809
toggle the value (on or off). This is useful when writing macros. Example: set
2505
2815
The unset command automatically prepends the no prefix to all specified
2506
2816
variables.
2507
2817
2508
Using the enter-command function in the index menu, you can query the value of
2509
a variable by prefixing the name of the variable with a question mark:
2818
Using the <enter-command> function in the index menu, you can query the value
2819
of a variable by prefixing the name of the variable with a question mark:
2510
2820
2511
2821
set ?allow_8bit
2512
2822
2515
2825
2516
2826
The reset command resets all given variables to the compile time defaults
2517
2827
(hopefully mentioned in this manual). If you use the command set and prefix the
2518
variable with ``&'' this has the same behavior as the reset command.
2828
variable with ?&? this has the same behavior as the reset command.
2519
2829
2520
With the reset command there exists the special variable ``all'', which allows
2830
With the reset command there exists the special variable ?all?, which allows
2521
2831
you to reset all variables to their system defaults.
2522
2832
2523
2833
26.2. User-defined variables
2528
2838
supports user-defined variables with names starting with my_ as in, for
2529
2839
example, my_cfgdir.
2530
2840
2531
The set command creates a custom $my_ variable and changes its value. The unset
2532
and reset commands remove the variable entirely.
2841
The set command either creates a custom my_ variable or changes its value if it
2842
does exist already. The unset and reset commands remove the variable entirely.
2533
2843
2534
2844
Since user-defined variables are expanded in the same way that environment
2535
variables are (except for the shell-escape command), this feature can be used
2536
to make configuration files more readable.
2845
variables are (except for the shell-escape command and backtick expansion),
2846
this feature can be used to make configuration files more readable.
2537
2847
2538
2848
26.2.2. Examples
2539
2849
2540
2850
The following example defines and uses the variable my_cfgdir to abbreviate the
2541
2851
calls of the source command:
2542
2852
2853
Example 3.14. Using user-defined variables for config file readability
2854
2543
2855
set my_cfgdir = $HOME/mutt/config
2544
2856
2545
2857
source $my_cfgdir/hooks
2546
2858
source $my_cfgdir/macros
2547
2859
# more source commands...
2548
2860
2861
2549
2862
A custom variable can also be used in macros to backup the current value of
2550
2863
another variable. In the following example, the value of the $delete is changed
2551
2864
temporarily while its original value is saved as my_delete. After the macro has
2552
2865
executed all commands, the original value of $delete is restored.
2553
2866
2867
Example 3.15. Using user-defined variables for backing up other config option
2868
values
2869
2554
2870
macro pager ,x '\
2555
2871
<enter-command>set my_delete=$delete<enter>\
2556
2872
<enter-command>set delete=yes<enter>\
2557
2873
...\
2558
2874
<enter-command>set delete=$my_delete<enter>'
2559
2875
2876
2560
2877
Since mutt expands such values already when parsing the configuration file(s),
2561
2878
the value of $my_delete in the last example would be the value of $delete
2562
2879
exactly as it was at that point during parsing the configuration file. If
2565
2882
be deferred to runtime, as shown in the next example, when escaping the dollar
2566
2883
sign.
2567
2884
2885
Example 3.16. Deferring user-defined variable expansion to runtime
2886
2568
2887
macro pager <PageDown> "\
2569
2888
<enter-command> set my_old_pager_stop=\$pager_stop pager_stop<Enter>\
2570
2889
<next-page>\
2571
2890
<enter-command> set pager_stop=\$my_old_pager_stop<Enter>\
2572
2891
<enter-command> unset my_old_pager_stop<Enter>"
2573
2892
2893
2574
2894
Note that there is a space between <enter-command> and the set configuration
2575
2895
command, preventing mutt from recording the macro's commands into its history.
2576
2896
2577
2897
27. Reading initialization commands from another file
2578
2898
2579
Usage: sourcefilename
2899
Usage:
2900
2901
source filename
2580
2902
2581
2903
This command allows the inclusion of initialization commands from other files.
2582
For example, I place all of my aliases in ~/.mail_aliases so that I can make my
2583
~/.muttrc readable and keep my aliases private.
2904
For example, I place all of my aliases in ?/.mail_aliases so that I can make my
2905
?/.muttrc readable and keep my aliases private.
2584
2906
2585
If the filename begins with a tilde (``~''), it will be expanded to the path of
2907
If the filename begins with a tilde (???), it will be expanded to the path of
2586
2908
your home directory.
2587
2909
2588
2910
If the filename ends with a vertical bar (|), then filename is considered to be
2589
an executable program from which to read input (eg. source ~/bin/myscript|).
2911
an executable program from which to read input (eg. source ?/bin/myscript|).
2590
2912
2591
2913
28. Removing hooks
2592
2914
2593
Usage: unhook [ * | hook-type ]
2915
Usage:
2916
2917
unhook { * | hook-type }
2594
2918
2595
2919
This command permits you to flush hooks you have previously defined. You can
2596
either remove all hooks by giving the ``*'' character as an argument, or you
2597
can remove all hooks of a specific type by saying something like unhook
2598
send-hook.
2920
either remove all hooks by giving the ?*? character as an argument, or you can
2921
remove all hooks of a specific type by saying something like unhook send-hook.
2599
2922
2600
2923
29. Format Strings
2601
2924
2602
2925
29.1. Basic usage
2603
2926
2604
2927
Format strings are a general concept you'll find in several locations through
2605
the mutt configuration, especially in the $index_format", $pager_format",
2606
$status_format", and other ``*_format'' variables. These can be very
2928
the mutt configuration, especially in the $index_format, $pager_format,
2929
$status_format, and other ?*_format? variables. These can be very
2607
2930
straightforward, and it's quite possible you already know how to use them.
2608
2931
2609
2932
The most basic format string element is a percent symbol followed by another
2610
2933
character. For example, %s represents a message's Subject: header in the
2611
$index_format" variable. The ``expandos'' available are documented with each
2934
$index_format variable. The ?expandos? available are documented with each
2612
2935
format variable, but there are general modifiers available with all formatting
2613
2936
expandos, too. Those are our concern here.
2614
2937
2615
Some of the modifers are borrowed right out of C (though you might know them
2616
from Perl, Python, shell, or another langugage). These are the [-]m.n
2617
modifiers, as in %-12.12s. As with such programming languages, these modifiers
2618
allow you to specify the minumum and maximum size of the resulting string, as
2619
well as its justification. If the ``-'' sign follows the percent, the string
2620
will be left-justified instead of right-justified. If there's a number
2621
immediately following that, it's the minimum amount of space the formatted
2622
string will occupy -- if it's naturally smaller than that, it will be padded
2623
out with spaces. If a decimal point and another number follow, that's the
2624
maximum space allowable -- the string will not be permitted to exceed that
2625
width, no matter its natural size. Each of these three elements is optional, so
2626
that all these are legal format strings: %-12s%4c%.15F%-12.15L
2938
Some of the modifiers are borrowed right out of C (though you might know them
2939
from Perl, Python, shell, or another language). These are the [-]m.n modifiers,
2940
as in %-12.12s. As with such programming languages, these modifiers allow you
2941
to specify the minimum and maximum size of the resulting string, as well as its
2942
justification. If the ?-? sign follows the percent, the string will be
2943
left-justified instead of right-justified. If there's a number immediately
2944
following that, it's the minimum amount of space the formatted string will
2945
occupy -- if it's naturally smaller than that, it will be padded out with
2946
spaces. If a decimal point and another number follow, that's the maximum space
2947
allowable -- the string will not be permitted to exceed that width, no matter
2948
its natural size. Each of these three elements is optional, so that all these
2949
are legal format strings: %-12s %4c %.15F %-12.15L
2627
2950
2628
2951
Mutt adds some other modifiers to format strings. If you use an equals symbol
2629
2952
(=) as a numeric prefix (like the minus above), it will force the string to be
2631
2954
characters for the %y expansion -- that's the X-Label: header, in
2632
2955
$index_format. If the expansion results in a string less than 14 characters, it
2633
2956
will be centered in a 14-character space. If the X-Label for a message were
2634
"test", that expansion would look like `` test ''.
2957
"test", that expansion would look like ? test ?.
2635
2958
2636
2959
There are two very little-known modifiers that affect the way that an expando
2637
is replaced. If there is an underline (``_'') character between any format
2960
is replaced. If there is an underline (?_?) character between any format
2638
2961
modifiers (as above) and the expando letter, it will expands in all lower case.
2639
And if you use a colon (``:''), it will replace all decimal points with
2962
And if you use a colon (?:?), it will replace all decimal points with
2640
2963
underlines.
2641
2964
2642
2965
29.2. Filters
2643
2966
2644
Any format string ending in a vertical bar (``|'') will be expanded and piped
2967
Any format string ending in a vertical bar (?|?) will be expanded and piped
2645
2968
through the first word in the string, using spaces as separator. The string
2646
2969
returned will be used for display. If the returned string ends in %, it will be
2647
2970
passed through the formatter a second time. This allows the filter to generate
2650
2973
All % expandos in a format string are expanded before the script is called so
2651
2974
that:
2652
2975
2976
Example 3.17. Using external filters in format strings
2977
2653
2978
set status_format="script.sh '%r %f (%L)'|"
2654
2979
2980
2655
2981
will make mutt expand %r, %f and %L before calling the script. The example also
2656
2982
shows that arguments can be quoted: the script will receive the expanded string
2657
2983
between the single quotes as the only argument.
2681
3007
6. Mailbox Formats
2682
3008
7. Mailbox Shortcuts
2683
3009
8. Handling Mailing Lists
2684
9. Editing threads
2685
2686
9.1. Linking threads
2687
9.2. Breaking threads
2688
2689
10. Delivery Status Notification (DSN) Support
2690
11. Start a WWW Browser on URLs (EXTERNAL)
3010
9. Handling multiple folders
3011
10. Editing threads
3012
3013
10.1. Linking threads
3014
10.2. Breaking threads
3015
3016
11. Delivery Status Notification (DSN) Support
3017
12. Start a WWW Browser on URLs
2691
3018
2692
3019
1. Regular Expressions
2693
3020
2694
3021
All string patterns in Mutt including those in more complex patterns must be
2695
specified using regular expressions (regexp) in the ``POSIX extended'' syntax
3022
specified using regular expressions (regexp) in the ?POSIX extended? syntax
2696
3023
(which is more or less the syntax used by egrep and GNU awk). For your
2697
3024
convenience, we have included below a brief description of this syntax.
2698
3025
2699
3026
The search is case sensitive if the pattern contains at least one upper case
2700
letter, and case insensitive otherwise. Note that ``\'' must be quoted if used
2701
for a regular expression in an initialization command: ``\\''.
3027
letter, and case insensitive otherwise.
3028
3029
Note
3030
3031
Note that ?\? must be quoted if used for a regular expression in an
3032
initialization command: ?\\?.
2702
3033
2703
3034
A regular expression is a pattern that describes a set of strings. Regular
2704
3035
expressions are constructed analogously to arithmetic expressions, by using
2705
3036
various operators to combine smaller expressions.
2706
3037
3038
Note
3039
2707
3040
Note that the regular expression can be enclosed/delimited by either " or '
2708
3041
which is useful if the regular expression includes a white-space character. See
2709
3042
Syntax of Initialization Files for more information on " and ' delimiter
2714
3047
expressions that match themselves. Any metacharacter with special meaning may
2715
3048
be quoted by preceding it with a backslash.
2716
3049
2717
The period ``.'' matches any single character. The caret ``^'' and the dollar
2718
sign ``$'' are metacharacters that respectively match the empty string at the
3050
The period ?.? matches any single character. The caret ?^? and the dollar sign
3051
?$? are metacharacters that respectively match the empty string at the
2719
3052
beginning and end of a line.
2720
3053
2721
A list of characters enclosed by ``['' and ``]'' matches any single character
2722
in that list; if the first character of the list is a caret ``^'' then it
2723
matches any character not in the list. For example, the regular expression
2724
[0123456789] matches any single digit. A range of ASCII characters may be
2725
specified by giving the first and last characters, separated by a hyphen ``-''.
2726
Most metacharacters lose their special meaning inside lists. To include a
2727
literal ``]'' place it first in the list. Similarly, to include a literal ``^''
2728
place it anywhere but first. Finally, to include a literal hyphen ``-'' place
2729
it last.
3054
A list of characters enclosed by ?[? and ?]? matches any single character in
3055
that list; if the first character of the list is a caret ?^? then it matches
3056
any character not in the list. For example, the regular expression [0123456789]
3057
matches any single digit. A range of ASCII characters may be specified by
3058
giving the first and last characters, separated by a hyphen ?-?. Most
3059
metacharacters lose their special meaning inside lists. To include a literal ?]
3060
? place it first in the list. Similarly, to include a literal ?^? place it
3061
anywhere but first. Finally, to include a literal hyphen ?-? place it last.
2730
3062
2731
3063
Certain named classes of characters are predefined. Character classes consist
2732
of ``[:'', a keyword denoting the class, and ``:]''. The following classes are
2733
defined by the POSIX standard:
2734
2735
[:alnum:]
2736
2737
Alphanumeric characters.
2738
2739
[:alpha:]
2740
2741
Alphabetic characters.
2742
2743
[:blank:]
2744
2745
Space or tab characters.
2746
2747
[:cntrl:]
2748
2749
Control characters.
2750
2751
[:digit:]
2752
2753
Numeric characters.
2754
2755
[:graph:]
2756
2757
Characters that are both printable and visible. (A space is printable, but
2758
not visible, while an ``a'' is both.)
2759
2760
[:lower:]
2761
2762
Lower-case alphabetic characters.
2763
2764
[:print:]
2765
2766
Printable characters (characters that are not control characters.)
2767
2768
[:punct:]
2769
2770
Punctuation characters (characters that are not letter, digits, control
2771
characters, or space characters).
2772
2773
[:space:]
2774
2775
Space characters (such as space, tab and formfeed, to name a few).
2776
2777
[:upper:]
2778
2779
Upper-case alphabetic characters.
2780
2781
[:xdigit:]
2782
2783
Characters that are hexadecimal digits.
3064
of ?[:?, a keyword denoting the class, and ?:]?. The following classes are
3065
defined by the POSIX standard in Table 4.1, ?POSIX regular expression character
3066
classes?
3067
3068
Table 4.1. POSIX regular expression character classes
3069
3070
+-----------------------------------------------------------------------------+
3071
|Character | Description |
3072
| class | |
3073
|----------+------------------------------------------------------------------|
3074
|[:alnum:] |Alphanumeric characters |
3075
|----------+------------------------------------------------------------------|
3076
|[:alpha:] |Alphabetic characters |
3077
|----------+------------------------------------------------------------------|
3078
|[:blank:] |Space or tab characters |
3079
|----------+------------------------------------------------------------------|
3080
|[:cntrl:] |Control characters |
3081
|----------+------------------------------------------------------------------|
3082
|[:digit:] |Numeric characters |
3083
|----------+------------------------------------------------------------------|
3084
|[:graph:] |Characters that are both printable and visible. (A space is |
3085
| |printable, but not visible, while an ?a? is both) |
3086
|----------+------------------------------------------------------------------|
3087
|[:lower:] |Lower-case alphabetic characters |
3088
|----------+------------------------------------------------------------------|
3089
|[:print:] |Printable characters (characters that are not control characters) |
3090
|----------+------------------------------------------------------------------|
3091
|[:punct:] |Punctuation characters (characters that are not letter, digits, |
3092
| |control characters, or space characters) |
3093
|----------+------------------------------------------------------------------|
3094
|[:space:] |Space characters (such as space, tab and formfeed, to name a few) |
3095
|----------+------------------------------------------------------------------|
3096
|[:upper:] |Upper-case alphabetic characters |
3097
|----------+------------------------------------------------------------------|
3098
|[:xdigit:]|Characters that are hexadecimal digits |
3099
+-----------------------------------------------------------------------------+
3100
2784
3101
2785
3102
A character class is only valid in a regular expression inside the brackets of
2786
a character list. Note that the brackets in these class names are part of the
2787
symbolic names, and must be included in addition to the brackets delimiting the
2788
bracket list. For example, [[:digit:]] is equivalent to [0-9].
3103
a character list.
3104
3105
Note
3106
3107
Note that the brackets in these class names are part of the symbolic names, and
3108
must be included in addition to the brackets delimiting the bracket list. For
3109
example, [[:digit:]] is equivalent to [0-9].
2789
3110
2790
3111
Two additional special sequences can appear in character lists. These apply to
2791
3112
non-ASCII character sets, which can have single symbols (called collating
2794
3115
2795
3116
Collating Symbols
2796
3117
2797
A collating symbol is a multi-character collating element enclosed in
2798
``[.'' and ``.]''. For example, if ``ch'' is a collating element, then
2799
[[.ch.]] is a regexp that matches this collating element, while [ch] is a
2800
regexp that matches either ``c'' or ``h''.
3118
A collating symbol is a multi-character collating element enclosed in ?[.?
3119
and ?.]?. For example, if ?ch? is a collating element, then [[.ch.]] is a
3120
regexp that matches this collating element, while [ch] is a regexp that
3121
matches either ?c? or ?h?.
2801
3122
2802
3123
Equivalence Classes
2803
3124
2804
3125
An equivalence class is a locale-specific name for a list of characters
2805
that are equivalent. The name is enclosed in ``[='' and ``=]''. For
2806
example, the name ``e'' might be used to represent all of ``è'' ``é'' and
2807
``e''. In this case, [[=e=]] is a regexp that matches any of ``è'', ``é''
2808
and ``e''.
3126
that are equivalent. The name is enclosed in ?[=? and ?=]?. For example,
3127
the name ?e? might be used to represent all of ??? ??? and ?e?. In this
3128
case, [[=e=]] is a regexp that matches any of ???, ??? and ?e?.
2809
3129
2810
3130
A regular expression matching a single character may be followed by one of
2811
several repetition operators:
2812
2813
?
2814
2815
The preceding item is optional and matched at most once.
2816
2817
*
2818
2819
The preceding item will be matched zero or more times.
2820
2821
+
2822
2823
The preceding item will be matched one or more times.
2824
2825
{n}
2826
2827
The preceding item is matched exactly n times.
2828
2829
{n,}
2830
2831
The preceding item is matched n or more times.
2832
2833
{,m}
2834
2835
The preceding item is matched at most m times.
2836
2837
{n,m}
2838
2839
The preceding item is matched at least n times, but no more than m times.
3131
several repetition operators described in Table 4.2, ?Regular expression
3132
repetition operators?.
3133
3134
Table 4.2. Regular expression repetition operators
3135
3136
+-----------------------------------------------------------------------------+
3137
|Operator| Description |
3138
|--------+--------------------------------------------------------------------|
3139
|? |The preceding item is optional and matched at most once |
3140
|--------+--------------------------------------------------------------------|
3141
|* |The preceding item will be matched zero or more times |
3142
|--------+--------------------------------------------------------------------|
3143
|+ |The preceding item will be matched one or more times |
3144
|--------+--------------------------------------------------------------------|
3145
|{n} |The preceding item is matched exactly n times |
3146
|--------+--------------------------------------------------------------------|
3147
|{n,} |The preceding item is matched n or more times |
3148
|--------+--------------------------------------------------------------------|
3149
|{,m} |The preceding item is matched at most m times |
3150
|--------+--------------------------------------------------------------------|
3151
|{n,m} |The preceding item is matched at least n times, but no more than m |
3152
| |times |
3153
+-----------------------------------------------------------------------------+
3154
2840
3155
2841
3156
Two regular expressions may be concatenated; the resulting regular expression
2842
3157
matches any string formed by concatenating two substrings that respectively
2843
3158
match the concatenated subexpressions.
2844
3159
2845
Two regular expressions may be joined by the infix operator ``|''; the
2846
resulting regular expression matches any string matching either subexpression.
3160
Two regular expressions may be joined by the infix operator ?|?; the resulting
3161
regular expression matches any string matching either subexpression.
2847
3162
2848
3163
Repetition takes precedence over concatenation, which in turn takes precedence
2849
3164
over alternation. A whole subexpression may be enclosed in parentheses to
2850
3165
override these precedence rules.
2851
3166
2852
Note: If you compile Mutt with the GNU rx package, the following operators may
2853
also be used in regular expressions:
2854
2855
\\y
2856
2857
Matches the empty string at either the beginning or the end of a word.
2858
2859
\\B
2860
2861
Matches the empty string within a word.
2862
2863
\\<
2864
2865
Matches the empty string at the beginning of a word.
2866
2867
\\>
2868
2869
Matches the empty string at the end of a word.
2870
2871
\\w
2872
2873
Matches any word-constituent character (letter, digit, or underscore).
2874
2875
\\W
2876
2877
Matches any character that is not word-constituent.
2878
2879
\\`
2880
2881
Matches the empty string at the beginning of a buffer (string).
2882
2883
\\'
2884
2885
Matches the empty string at the end of a buffer.
3167
Note
3168
3169
If you compile Mutt with the GNU rx package, the following operators may also
3170
be used in regular expressions as described in Table 4.3, ?GNU regular
3171
expression extensions?.
3172
3173
Table 4.3. GNU regular expression extensions
3174
3175
+-----------------------------------------------------------------------------+
3176
|Expression| Description |
3177
|----------+------------------------------------------------------------------|
3178
|\\y |Matches the empty string at either the beginning or the end of a |
3179
| |word |
3180
|----------+------------------------------------------------------------------|
3181
|\\B |Matches the empty string within a word |
3182
|----------+------------------------------------------------------------------|
3183
|\\< |Matches the empty string at the beginning of a word |
3184
|----------+------------------------------------------------------------------|
3185
|\\> |Matches the empty string at the end of a word |
3186
|----------+------------------------------------------------------------------|
3187
|\\w |Matches any word-constituent character (letter, digit, or |
3188
| |underscore) |
3189
|----------+------------------------------------------------------------------|
3190
|\\W |Matches any character that is not word-constituent |
3191
|----------+------------------------------------------------------------------|
3192
|\\` |Matches the empty string at the beginning of a buffer (string) |
3193
|----------+------------------------------------------------------------------|
3194
|\\' |Matches the empty string at the end of a buffer |
3195
+-----------------------------------------------------------------------------+
3196
2886
3197
2887
3198
Please note however that these operators are not defined by POSIX, so they may
2888
3199
or may not be available in stock libraries on various systems.
2890
3201
2. Patterns: Searching, Limiting and Tagging
2891
3202
2892
3203
Many of Mutt's commands allow you to specify a pattern to match (limit,
2893
tag-pattern, delete-pattern, etc.). Table 4.1, "Pattern modifiers" shows
3204
tag-pattern, delete-pattern, etc.). Table 4.4, ?Pattern modifiers? shows
2894
3205
several ways to select messages.
2895
3206
2896
Table 4.1. Pattern modifiers
3207
Table 4.4. Pattern modifiers
2897
3208
2898
┌─────────┬───────────────────────────────────────────────────────────────────┐
2899
│ Pattern │ Description │
2900
│modifier │ │
2901
├─────────┼───────────────────────────────────────────────────────────────────┤
2902
│~A │all messages │
2903
├─────────┼───────────────────────────────────────────────────────────────────┤
2904
│~b EXPR │messages which contain EXPR in the message body │
2905
├─────────┼───────────────────────────────────────────────────────────────────┤
2906
│ │messages which contain STRING in the message body. If IMAP is │
2907
│=b STRING│enabled, searches for STRING on the server, rather than downloading│
2908
│ │each message and searching it locally. │
2909
├─────────┼───────────────────────────────────────────────────────────────────┤
2910
│~B EXPR │messages which contain EXPR in the whole message │
2911
├─────────┼───────────────────────────────────────────────────────────────────┤
2912
│~c EXPR │messages carbon-copied to EXPR │
2913
├─────────┼───────────────────────────────────────────────────────────────────┤
2914
│%c GROUP │messages carbon-copied to any member of GROUP │
2915
├─────────┼───────────────────────────────────────────────────────────────────┤
2916
│~C EXPR │message is either to: or cc: EXPR │
2917
├─────────┼───────────────────────────────────────────────────────────────────┤
2918
│%C GROUP │message is either to: or cc: to any member of GROUP │
2919
├─────────┼───────────────────────────────────────────────────────────────────┤
2920
│~d [MIN]-│messages with ``date-sent'' in a Date range │
2921
│[MAX] │ │
2922
├─────────┼───────────────────────────────────────────────────────────────────┤
2923
│~D │deleted messages │
2924
├─────────┼───────────────────────────────────────────────────────────────────┤
2925
│~e EXPR │message which contains EXPR in the ``Sender'' field │
2926
├─────────┼───────────────────────────────────────────────────────────────────┤
2927
│%e GROUP │message which contain a member of GROUP in the ``Sender'' field │
2928
├─────────┼───────────────────────────────────────────────────────────────────┤
2929
│~E │expired messages │
2930
├─────────┼───────────────────────────────────────────────────────────────────┤
2931
│~F │flagged messages │
2932
├─────────┼───────────────────────────────────────────────────────────────────┤
2933
│~f EXPR │messages originating from EXPR │
2934
├─────────┼───────────────────────────────────────────────────────────────────┤
2935
│%f GROUP │messages originating from any member of GROUP │
2936
├─────────┼───────────────────────────────────────────────────────────────────┤
2937
│~g │cryptographically signed messages │
2938
├─────────┼───────────────────────────────────────────────────────────────────┤
2939
│~G │cryptographically encrypted messages │
2940
├─────────┼───────────────────────────────────────────────────────────────────┤
2941
│~h EXPR │messages which contain EXPR in the message header │
2942
├─────────┼───────────────────────────────────────────────────────────────────┤
2943
│~H EXPR │messages with a spam attribute matching EXPR │
2944
├─────────┼───────────────────────────────────────────────────────────────────┤
2945
│~i EXPR │message which match EXPR in the ``Message-ID'' field │
2946
├─────────┼───────────────────────────────────────────────────────────────────┤
2947
│~k │message contains PGP key material │
2948
├─────────┼───────────────────────────────────────────────────────────────────┤
2949
│~L EXPR │message is either originated or received by EXPR │
2950
├─────────┼───────────────────────────────────────────────────────────────────┤
2951
│%L GROUP │message is either originated or received by any member of GROUP │
2952
├─────────┼───────────────────────────────────────────────────────────────────┤
2953
│~l │message is addressed to a known mailing list │
2954
├─────────┼───────────────────────────────────────────────────────────────────┤
2955
│~m [MIN]-│message in the range MIN to MAX *) │
2956
│[MAX] │ │
2957
├─────────┼───────────────────────────────────────────────────────────────────┤
2958
│~n [MIN]-│messages with a score in the range MIN to MAX *) │
2959
│[MAX] │ │
2960
├─────────┼───────────────────────────────────────────────────────────────────┤
2961
│~N │new messages │
2962
├─────────┼───────────────────────────────────────────────────────────────────┤
2963
│~O │old messages │
2964
├─────────┼───────────────────────────────────────────────────────────────────┤
2965
│~p │message is addressed to you (consults alternates) │
2966
├─────────┼───────────────────────────────────────────────────────────────────┤
2967
│~P │message is from you (consults alternates) │
2968
├─────────┼───────────────────────────────────────────────────────────────────┤
2969
│~Q │messages which have been replied to │
2970
├─────────┼───────────────────────────────────────────────────────────────────┤
2971
│~r [MIN]-│messages with ``date-received'' in a Date range │
2972
│[MAX] │ │
2973
├─────────┼───────────────────────────────────────────────────────────────────┤
2974
│~R │read messages │
2975
├─────────┼───────────────────────────────────────────────────────────────────┤
2976
│~s EXPR │messages having EXPR in the ``Subject'' field. │
2977
├─────────┼───────────────────────────────────────────────────────────────────┤
2978
│~S │superseded messages │
2979
├─────────┼───────────────────────────────────────────────────────────────────┤
2980
│~t EXPR │messages addressed to EXPR │
2981
├─────────┼───────────────────────────────────────────────────────────────────┤
2982
│~T │tagged messages │
2983
├─────────┼───────────────────────────────────────────────────────────────────┤
2984
│~u │message is addressed to a subscribed mailing list │
2985
├─────────┼───────────────────────────────────────────────────────────────────┤
2986
│~U │unread messages │
2987
├─────────┼───────────────────────────────────────────────────────────────────┤
2988
│~v │message is part of a collapsed thread. │
2989
├─────────┼───────────────────────────────────────────────────────────────────┤
2990
│~V │cryptographically verified messages │
2991
├─────────┼───────────────────────────────────────────────────────────────────┤
2992
│~x EXPR │messages which contain EXPR in the `References' field │
2993
├─────────┼───────────────────────────────────────────────────────────────────┤
2994
│~X [MIN]-│messages with MIN to MAX attachments *) │
2995
│[MAX] │ │
2996
├─────────┼───────────────────────────────────────────────────────────────────┤
2997
│~y EXPR │messages which contain EXPR in the `X-Label' field │
2998
├─────────┼───────────────────────────────────────────────────────────────────┤
2999
│~z [MIN]-│messages with a size in the range MIN to MAX *) │
3000
│[MAX] │ │
3001
├─────────┼───────────────────────────────────────────────────────────────────┤
3002
│~= │duplicated messages (see $duplicate_threads) │
3003
├─────────┼───────────────────────────────────────────────────────────────────┤
3004
│~$ │unreferenced messages (requires threaded view) │
3005
├─────────┼───────────────────────────────────────────────────────────────────┤
3006
│~ │messages in threads containing messages matching a certain pattern,│
3007
│(PATTERN)│e.g. all threads containing messages from you: ~(~P) │
3008
└─────────┴───────────────────────────────────────────────────────────────────┘
3209
+-----------------------------------------------------------------------------+
3210
| Pattern | Description |
3211
|modifier | |
3212
|---------+-------------------------------------------------------------------|
3213
|~A |all messages |
3214
|---------+-------------------------------------------------------------------|
3215
|~b EXPR |messages which contain EXPR in the message body |
3216
|---------+-------------------------------------------------------------------|
3217
| |messages which contain STRING in the message body. If IMAP is |
3218
|=b STRING|enabled, searches for STRING on the server, rather than downloading|
3219
| |each message and searching it locally. |
3220
|---------+-------------------------------------------------------------------|
3221
|~B EXPR |messages which contain EXPR in the whole message |
3222
|---------+-------------------------------------------------------------------|
3223
|~c EXPR |messages carbon-copied to EXPR |
3224
|---------+-------------------------------------------------------------------|
3225
|%c GROUP |messages carbon-copied to any member of GROUP |
3226
|---------+-------------------------------------------------------------------|
3227
|~C EXPR |messages either to: or cc: EXPR |
3228
|---------+-------------------------------------------------------------------|
3229
|%C GROUP |messages either to: or cc: to any member of GROUP |
3230
|---------+-------------------------------------------------------------------|
3231
|~d [MIN]-|messages with ?date-sent? in a Date range |
3232
|[MAX] | |
3233
|---------+-------------------------------------------------------------------|
3234
|~D |deleted messages |
3235
|---------+-------------------------------------------------------------------|
3236
|~e EXPR |messages which contains EXPR in the ?Sender? field |
3237
|---------+-------------------------------------------------------------------|
3238
|%e GROUP |messages which contain a member of GROUP in the ?Sender? field |
3239
|---------+-------------------------------------------------------------------|
3240
|~E |expired messages |
3241
|---------+-------------------------------------------------------------------|
3242
|~F |flagged messages |
3243
|---------+-------------------------------------------------------------------|
3244
|~f EXPR |messages originating from EXPR |
3245
|---------+-------------------------------------------------------------------|
3246
|%f GROUP |messages originating from any member of GROUP |
3247
|---------+-------------------------------------------------------------------|
3248
|~g |cryptographically signed messages |
3249
|---------+-------------------------------------------------------------------|
3250
|~G |cryptographically encrypted messages |
3251
|---------+-------------------------------------------------------------------|
3252
|~h EXPR |messages which contain EXPR in the message header |
3253
|---------+-------------------------------------------------------------------|
3254
|~H EXPR |messages with a spam attribute matching EXPR |
3255
|---------+-------------------------------------------------------------------|
3256
|~i EXPR |messages which match EXPR in the ?Message-ID? field |
3257
|---------+-------------------------------------------------------------------|
3258
|~k |messages which contain PGP key material |
3259
|---------+-------------------------------------------------------------------|
3260
|~L EXPR |messages either originated or received by EXPR |
3261
|---------+-------------------------------------------------------------------|
3262
|%L GROUP |message either originated or received by any member of GROUP |
3263
|---------+-------------------------------------------------------------------|
3264
|~l |messages addressed to a known mailing list |
3265
|---------+-------------------------------------------------------------------|
3266
|~m [MIN]-|messages in the range MIN to MAX *) |
3267
|[MAX] | |
3268
|---------+-------------------------------------------------------------------|
3269
|~n [MIN]-|messages with a score in the range MIN to MAX *) |
3270
|[MAX] | |
3271
|---------+-------------------------------------------------------------------|
3272
|~N |new messages |
3273
|---------+-------------------------------------------------------------------|
3274
|~O |old messages |
3275
|---------+-------------------------------------------------------------------|
3276
|~p |messages addressed to you (consults alternates) |
3277
|---------+-------------------------------------------------------------------|
3278
|~P |messages from you (consults alternates) |
3279
|---------+-------------------------------------------------------------------|
3280
|~Q |messages which have been replied to |
3281
|---------+-------------------------------------------------------------------|
3282
|~r [MIN]-|messages with ?date-received? in a Date range |
3283
|[MAX] | |
3284
|---------+-------------------------------------------------------------------|
3285
|~R |read messages |
3286
|---------+-------------------------------------------------------------------|
3287
|~s EXPR |messages having EXPR in the ?Subject? field. |
3288
|---------+-------------------------------------------------------------------|
3289
|~S |superseded messages |
3290
|---------+-------------------------------------------------------------------|
3291
|~t EXPR |messages addressed to EXPR |
3292
|---------+-------------------------------------------------------------------|
3293
|~T |tagged messages |
3294
|---------+-------------------------------------------------------------------|
3295
|~u |messages addressed to a subscribed mailing list |
3296
|---------+-------------------------------------------------------------------|
3297
|~U |unread messages |
3298
|---------+-------------------------------------------------------------------|
3299
|~v |messages part of a collapsed thread. |
3300
|---------+-------------------------------------------------------------------|
3301
|~V |cryptographically verified messages |
3302
|---------+-------------------------------------------------------------------|
3303
|~x EXPR |messages which contain EXPR in the ?References? field |
3304
|---------+-------------------------------------------------------------------|
3305
|~X [MIN]-|messages with MIN to MAX attachments *) |
3306
|[MAX] | |
3307
|---------+-------------------------------------------------------------------|
3308
|~y EXPR |messages which contain EXPR in the ?X-Label? field |
3309
|---------+-------------------------------------------------------------------|
3310
|~z [MIN]-|messages with a size in the range MIN to MAX *) |
3311
|[MAX] | |
3312
|---------+-------------------------------------------------------------------|
3313
|~= |duplicated messages (see $duplicate_threads) |
3314
|---------+-------------------------------------------------------------------|
3315
|~$ |unreferenced messages (requires threaded view) |
3316
|---------+-------------------------------------------------------------------|
3317
|~(PATTERN|messages in threads containing messages matching PATTERN, e.g. all |
3318
|) |threads containing messages from you: ~(~P) |
3319
+-----------------------------------------------------------------------------+
3009
3320
3010
3321
3011
3322
Where EXPR is a regular expression. Special attention has to be made when using
3012
3323
regular expressions inside of patterns. Specifically, Mutt's parser for these
3013
patterns will strip one level of backslash (\), which is normally used for
3324
patterns will strip one level of backslash (?\?), which is normally used for
3014
3325
quoting. If it is your intention to use a backslash in the regular expression,
3015
you will need to use two backslashes instead (\\). You can force mutt to treat
3016
EXPR as a simple string instead of a regular expression by using = instead of ~
3017
in the pattern name. For example, =b *.* will find all messages that contain
3018
the literal string '*.*'. Simple string matches are less powerful than regular
3019
expressions but can be considerably faster. This is especially true for IMAP
3020
folders, because string matches can be performed on the server instead of by
3021
fetching every message. IMAP treats =h specially: it must be of the form
3022
"header: substring" and will not partially match header names. The substring
3023
part may be omitted if you simply wish to find messages containing a particular
3024
header without regard to its value.
3326
you will need to use two backslashes instead (?\\?). You can force mutt to
3327
treat EXPR as a simple string instead of a regular expression by using =
3328
instead of ? in the pattern name. For example, =b *.* will find all messages
3329
that contain the literal string ?*.*?. Simple string matches are less powerful
3330
than regular expressions but can be considerably faster. This is especially
3331
true for IMAP folders, because string matches can be performed on the server
3332
instead of by fetching every message. IMAP treats =h specially: it must be of
3333
the form "header: substring" and will not partially match header names. The
3334
substring part may be omitted if you simply wish to find messages containing a
3335
particular header without regard to its value.
3025
3336
3026
*) The forms <[MAX], >[MIN], [MIN]- and -[MAX] are allowed, too.
3337
*) The forms ?<[MAX]?, ?>[MIN]?, ?[MIN]-? and ?-[MAX]? are allowed, too.
3027
3338
3028
3339
2.1. Pattern Modifier
3029
3340
3030
Note that patterns matching 'lists' of addresses (notably c,C,p,P and t) match
3031
if there is at least one match in the whole list. If you want to make sure that
3032
all elements of that list match, you need to prefix your pattern with ^. This
3033
example matches all mails which only has recipients from Germany.
3341
Note
3342
3343
Note that patterns matching 'lists' of addresses (notably c, C, p, P and t)
3344
match if there is at least one match in the whole list. If you want to make
3345
sure that all elements of that list match, you need to prefix your pattern with
3346
?^?. This example matches all mails which only has recipients from Germany.
3034
3347
3035
3348
^~C \.de$
3036
3349
3037
3350
2.2. Simple Patterns
3038
3351
3039
Mutt supports two versions of so called ``simple searches'' which are issued if
3352
Mutt supports two versions of so called ?simple searches? which are issued if
3040
3353
the query entered for searching, limiting and similar operations does not seem
3041
to be a valid pattern (i.e. it does not contain one of these characters: ``~'',
3042
``='' or ``%''). If the query is supposed to contain one of these special
3043
characters, they must be escaped by prepending a backslash (``\'').
3354
to be a valid pattern (i.e. it does not contain one of these characters: ???, ?
3355
=? or ?%?). If the query is supposed to contain one of these special
3356
characters, they must be escaped by prepending a backslash (?\?).
3044
3357
3045
3358
The first type is by checking whether the query string equals a keyword
3046
case-insensitively from Table 4.2, "Simple search keywords": If that is the
3359
case-insensitively from Table 4.5, ?Simple search keywords?: If that is the
3047
3360
case, Mutt will use the shown pattern modifier instead. If a keyword would
3048
3361
conflict with your search keyword, you need to turn it into a regular
3049
3362
expression to avoid matching the keyword table. For example, if you want to
3050
find all messages matching ``flag'' (using $simple_search, see below but not
3051
meaning flagged messages) simply search for ``[f]lag''.
3052
3053
Table 4.2. Simple search keywords
3054
3055
┌───────┬─────────────────┐
3056
│Keyword│Pattern modifier │
3057
├───────┼─────────────────┤
3058
│all │~A │
3059
├───────┼─────────────────┤
3060
│. │~A │
3061
├───────┼─────────────────┤
3062
│^ │~A │
3063
├───────┼─────────────────┤
3064
│del │~D │
3065
├───────┼─────────────────┤
3066
│flag │~F │
3067
├───────┼─────────────────┤
3068
│new │~N │
3069
├───────┼─────────────────┤
3070
│old │~O │
3071
├───────┼─────────────────┤
3072
│repl │~Q │
3073
├───────┼─────────────────┤
3074
│read │~R │
3075
├───────┼─────────────────┤
3076
│tag │~T │
3077
├───────┼─────────────────┤
3078
│unread │~U │
3079
└───────┴─────────────────┘
3363
find all messages matching ?flag? (using $simple_search) but don't want to
3364
match flagged messages, simply search for ?[f]lag?.
3365
3366
Table 4.5. Simple search keywords
3367
3368
+-------------------------+
3369
|Keyword|Pattern modifier |
3370
|-------+-----------------|
3371
|all |~A |
3372
|-------+-----------------|
3373
|. |~A |
3374
|-------+-----------------|
3375
|^ |~A |
3376
|-------+-----------------|
3377
|del |~D |
3378
|-------+-----------------|
3379
|flag |~F |
3380
|-------+-----------------|
3381
|new |~N |
3382
|-------+-----------------|
3383
|old |~O |
3384
|-------+-----------------|
3385
|repl |~Q |
3386
|-------+-----------------|
3387
|read |~R |
3388
|-------+-----------------|
3389
|tag |~T |
3390
|-------+-----------------|
3391
|unread |~U |
3392
+-------------------------+
3080
3393
3081
3394
3082
3395
The second type of simple search is to build a complex search pattern using
3089
3402
3090
3403
~t mutt ~f elkins
3091
3404
3092
would select messages which contain the word ``mutt'' in the list of recipients
3093
and that have the word ``elkins'' in the ``From'' header field.
3405
would select messages which contain the word ?mutt? in the list of recipients
3406
and that have the word ?elkins? in the ?From? header field.
3094
3407
3095
3408
Mutt also recognizes the following operators to create more complex search
3096
3409
patterns:
3097
3410
3098
● ! -- logical NOT operator
3099
3100
● | -- logical OR operator
3101
3102
● () -- logical grouping operator
3411
* ! -- logical NOT operator
3412
3413
* | -- logical OR operator
3414
3415
* () -- logical grouping operator
3103
3416
3104
3417
Here is an example illustrating a complex search pattern. This pattern will
3105
select all messages which do not contain ``mutt'' in the ``To'' or ``Cc'' field
3106
and which are from ``elkins''.
3418
select all messages which do not contain ?mutt? in the ?To? or ?Cc? field and
3419
which are from ?elkins?.
3420
3421
Example 4.1. Using boolean operators in patterns
3107
3422
3108
3423
!(~t mutt|~c mutt) ~f elkins
3109
3424
3425
3110
3426
Here is an example using white space in the regular expression (note the ' and
3111
" delimiters). For this to match, the mail's subject must match the ``^Junk
3112
+From +Me$'' and it must be from either ``Jim +Somebody'' or ``Ed
3113
+SomeoneElse'':
3427
" delimiters). For this to match, the mail's subject must match the ?^Junk
3428
+From +Me$? and it must be from either ?Jim +Somebody? or ?Ed +SomeoneElse?:
3114
3429
3115
3430
'~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
3116
3431
3117
Note that if a regular expression contains parenthesis, or a vertical bar ("|
3118
"), you must enclose the expression in double or single quotes since those
3119
characters are also used to separate different parts of Mutt's pattern
3120
language. For example,
3432
Note
3121
3433
3434
If a regular expression contains parenthesis, or a vertical bar ("|"), you must
3435
enclose the expression in double or single quotes since those characters are
3436
also used to separate different parts of Mutt's pattern language. For example:
3122
3437
~f "me@(mutt\.org|cs\.hmc\.edu)"
3123
3438
3124
Without the quotes, the parenthesis wouldn't end. This would be seperated to
3125
two OR'd patterns: ~f me@(mutt\.org and cs\.hmc\.edu). They are never what you
3439
Without the quotes, the parenthesis wouldn't end. This would be separated to
3440
two OR'd patterns: ?f me@(mutt\.org and cs\.hmc\.edu). They are never what you
3126
3441
want.
3127
3442
3128
3443
2.4. Searching by Date
3135
3450
3136
3451
Limit to messages matching: ~d 20/1/95-31/10
3137
3452
3138
If you omit the minimum (first) date, and just specify ``-DD/MM/YY'', all
3453
If you omit the minimum (first) date, and just specify ?-DD/MM/YY?, all
3139
3454
messages before the given date will be selected. If you omit the maximum
3140
(second) date, and specify ``DD/MM/YY-'', all messages after the given date
3141
will be selected. If you specify a single date with no dash (``-''), only
3142
messages sent on the given date will be selected.
3455
(second) date, and specify ?DD/MM/YY-?, all messages after the given date will
3456
be selected. If you specify a single date with no dash (?-?), only messages
3457
sent on the given date will be selected.
3143
3458
3144
3459
Error Margins. You can add error margins to absolute dates. An error margin is
3145
a sign (+ or -), followed by a digit, followed by one of the units in Table
3146
4.3, "Date units". As a special case, you can replace the sign by a ``*''
3460
a sign (+ or -), followed by a digit, followed by one of the units in
3461
Table 4.6, ?Date units?. As a special case, you can replace the sign by a ?*?
3147
3462
character, which is equivalent to giving identical plus and minus error
3148
3463
margins.
3149
3464
3150
Table 4.3. Date units
3465
Table 4.6. Date units
3151
3466
3152
┌────┬────────────┐
3153
│Unit│Description │
3154
├────┼────────────┤
3155
│y │Years │
3156
├────┼────────────┤
3157
│m │Months │
3158
├────┼────────────┤
3159
│w │Weeks │
3160
├────┼────────────┤
3161
│d │Days │
3162
└────┴────────────┘
3467
+-----------------+
3468
|Unit|Description |
3469
|----+------------|
3470
|y |Years |
3471
|----+------------|
3472
|m |Months |
3473
|----+------------|
3474
|w |Weeks |
3475
|----+------------|
3476
|d |Days |
3477
+-----------------+
3163
3478
3164
3479
3165
3480
Example: To select any messages two weeks around January 15, 2001, you'd use
3166
3481
the following pattern:
3167
3482
3168
3169
3483
Limit to messages matching: ~d 15/1/2001*2w
3170
3484
3171
3485
Relative. This type of date is relative to the current date, and may be
3172
3486
specified as:
3173
3487
3174
● >offset (messages older than offset units)
3175
3176
● <offset (messages newer than offset units)
3177
3178
● =offset (messages exactly offset units old)
3179
3180
offset is specified as a positive number with one of the units from Table 4.3,
3181
"Date units".
3488
* >offset (messages older than offset units)
3489
3490
* <offset (messages newer than offset units)
3491
3492
* =offset (messages exactly offset units old)
3493
3494
offset is specified as a positive number with one of the units from Table 4.6,
3495
?Date units?.
3182
3496
3183
3497
Example: to select messages less than 1 month old, you would use
3184
3498
3185
3499
Limit to messages matching: ~d <1m
3186
3500
3187
Note: all dates used when searching are relative to the local time zone, so
3188
unless you change the setting of your $index_format to include a %[...] format,
3189
these are not the dates shown in the main index.
3501
Note
3502
3503
All dates used when searching are relative to the local time zone, so unless
3504
you change the setting of your $index_format to include a %[...] format, these
3505
are not the dates shown in the main index.
3190
3506
3191
3507
3. Using Tags
3192
3508
3193
3509
Sometimes it is desirable to perform an operation on a group of messages all at
3194
3510
once rather than one at a time. An example might be to save messages to a
3195
3511
mailing list to a separate folder, or to delete all messages with a given
3196
subject. To tag all messages matching a pattern, use the tag-pattern function,
3197
which is bound to ``shift-T'' by default. Or you can select individual messages
3198
by hand using the ``tag-message'' function, which is bound to ``t'' by default.
3199
See patterns for Mutt's pattern matching syntax.
3200
3201
Once you have tagged the desired messages, you can use the ``tag-prefix''
3202
operator, which is the ``;'' (semicolon) key by default. When the
3203
``tag-prefix'' operator is used, the next operation will be applied to all
3204
tagged messages if that operation can be used in that manner. If the $auto_tag
3205
variable is set, the next operation applies to the tagged messages
3206
automatically, without requiring the ``tag-prefix''.
3207
3208
In macros or push commands, you can use the ``tag-prefix-cond'' operator. If
3512
subject. To tag all messages matching a pattern, use the <tag-pattern>
3513
function, which is bound to ?shift-T? by default. Or you can select individual
3514
messages by hand using the <tag-message> function, which is bound to ?t? by
3515
default. See patterns for Mutt's pattern matching syntax.
3516
3517
Once you have tagged the desired messages, you can use the ?tag-prefix?
3518
operator, which is the ?;? (semicolon) key by default. When the ?tag-prefix?
3519
operator is used, the next operation will be applied to all tagged messages if
3520
that operation can be used in that manner. If the $auto_tag variable is set,
3521
the next operation applies to the tagged messages automatically, without
3522
requiring the ?tag-prefix?.
3523
3524
In macros or push commands, you can use the ?tag-prefix-cond? operator. If
3209
3525
there are no tagged messages, mutt will "eat" the rest of the macro to abort
3210
3526
it's execution. Mutt will stop "eating" the macro when it encounters the
3211
``end-cond'' operator; after this operator the rest of the macro will be
3212
executed as normal.
3527
?end-cond? operator; after this operator the rest of the macro will be executed
3528
as normal.
3213
3529
3214
3530
4. Using Hooks
3215
3531
3216
A hook is a concept borrowed from the EMACS editor which allows you to execute
3532
A hook is a concept found in many other programs which allows you to execute
3217
3533
arbitrary commands before performing some operation. For example, you may wish
3218
3534
to tailor your configuration based upon which mailbox you are reading, or to
3219
3535
whom you are sending mail. In the Mutt world, a hook consists of a regular
3220
3536
expression or pattern along with a configuration option/command. See
3221
3537
3222
● folder-hook
3223
3224
● send-hook
3225
3226
● message-hook
3227
3228
● save-hook
3229
3230
● mbox-hook
3231
3232
● fcc-hook
3233
3234
● fcc-save-hook
3538
* folder-hook
3539
3540
* send-hook
3541
3542
* message-hook
3543
3544
* save-hook
3545
3546
* mbox-hook
3547
3548
* fcc-hook
3549
3550
* fcc-save-hook
3235
3551
3236
3552
for specific details on each type of hook available.
3237
3553
3238
Note: if a hook changes configuration settings, these changes remain effective
3239
until the end of the current mutt session. As this is generally not desired, a
3554
Note
3555
3556
If a hook changes configuration settings, these changes remain effective until
3557
the end of the current mutt session. As this is generally not desired, a
3240
3558
default hook needs to be added before all other hooks to restore configuration
3241
3559
defaults. Here is an example with send-hook and the my_hdr directive:
3242
3560
3561
Example 4.2. Combining send-hook and my_hdr
3562
3243
3563
send-hook . 'unmy_hdr From:'
3244
3564
send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
3245
3565
3566
3246
3567
4.1. Message Matching in Hooks
3247
3568
3248
3569
Hooks that act upon messages (message-hook, reply-hook, send-hook, send2-hook,
3294
3615
roessler@does-not-exist.org Thomas Roessler mutt pgp
3295
3616
3296
3617
There are two mechanisms for accessing the query function of mutt. One is to do
3297
a query from the index menu using the query function (default: Q). This will
3618
a query from the index menu using the <query> function (default: Q). This will
3298
3619
prompt for a query, then bring up the query menu which will list the matching
3299
3620
responses. From the query menu, you can select addresses to create aliases, or
3300
3621
to mail. You can tag multiple addresses to mail, start a new query, or have a
3302
3623
3303
3624
The other mechanism for accessing the query function is for address completion,
3304
3625
similar to the alias completion. In any prompt for address entry, you can use
3305
the complete-query function (default: ^T) to run a query based on the current
3626
the <complete-query> function (default: ^T) to run a query based on the current
3306
3627
address you have typed. Like aliases, mutt will look for what you have typed
3307
3628
back to the last space or comma. If there is a single response for that query,
3308
3629
mutt will expand the address in place. If there are multiple responses, mutt
3321
3642
3322
3643
From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
3323
3644
3324
to denote the start of a new message (this is often referred to as the
3325
``From_'' line).
3645
to denote the start of a new message (this is often referred to as the ?From_?
3646
line).
3326
3647
3327
3648
MMDF. This is a variant of the mbox format. Each message is surrounded by lines
3328
containing ``^A^A^A^A'' (four control-A's).
3649
containing ?^A^A^A^A? (four control-A's).
3329
3650
3330
3651
MH. A radical departure from mbox and MMDF, a mailbox consists of a directory
3331
3652
and each message is stored in a separate file. The filename indicates the
3332
3653
message number (however, this is may not correspond to the message number Mutt
3333
3654
displays). Deleted messages are renamed with a comma (,) prepended to the
3334
filename. Note: Mutt detects this type of mailbox by looking for either
3335
.mh_sequences or .xmhcache (needed to distinguish normal directories from MH
3336
mailboxes).
3655
filename. Mutt detects this type of mailbox by looking for either .mh_sequences
3656
or .xmhcache (needed to distinguish normal directories from MH mailboxes).
3337
3657
3338
3658
Maildir. The newest of the mailbox formats, used by the Qmail MTA (a
3339
3659
replacement for sendmail). Similar to MH, except that it adds three
3347
3667
These shortcuts can be used anywhere you are prompted for a file or mailbox
3348
3668
path.
3349
3669
3350
● ! -- refers to your $spoolfile (incoming) mailbox
3351
3352
● > -- refers to your $mbox file
3353
3354
● < -- refers to your $record file
3355
3356
● ^ -- refers to the current mailbox
3357
3358
● - or !! -- refers to the file you've last visited
3359
3360
● ~ -- refers to your home directory
3361
3362
● = or + -- refers to your $folder directory
3363
3364
● @alias -- refers to the default save folder as determined by the address of
3670
* ! -- refers to your $spoolfile (incoming) mailbox
3671
3672
* > -- refers to your $mbox file
3673
3674
* < -- refers to your $record file
3675
3676
* ^ -- refers to the current mailbox
3677
3678
* - or !! -- refers to the file you've last visited
3679
3680
* ? -- refers to your home directory
3681
3682
* = or + -- refers to your $folder directory
3683
3684
* @alias -- refers to the default save folder as determined by the address of
3365
3685
the alias
3366
3686
3367
3687
8. Handling Mailing Lists
3377
3697
first of which is the ability to show the name of a list through which you
3378
3698
received a message (i.e., of a subscribed list) in the index menu display. This
3379
3699
is useful to distinguish between personal and list mail in the same mailbox. In
3380
the $index_format variable, the escape ``%L'' will return the string ``To
3381
<list>'' when ``list'' appears in the ``To'' field, and ``Cc <list>'' when it
3382
appears in the ``Cc'' field (otherwise it returns the name of the author).
3700
the $index_format variable, the escape ?%L? will return the string ?To <list>?
3701
when ?list? appears in the ?To? field, and ?Cc <list>? when it appears in the
3702
?Cc? field (otherwise it returns the name of the author).
3383
3703
3384
Often times the ``To'' and ``Cc'' fields in mailing list messages tend to get
3385
quite large. Most people do not bother to remove the author of the message they
3386
are reply to from the list, resulting in two or more copies being sent to that
3387
person. The ``list-reply'' function, which by default is bound to ``L'' in the
3388
index menu and pager, helps reduce the clutter by only replying to the known
3389
mailing list addresses instead of all recipients (except as specified by
3390
Mail-Followup-To, see below).
3704
Often times the ?To? and ?Cc? fields in mailing list messages tend to get quite
3705
large. Most people do not bother to remove the author of the message they reply
3706
to from the list, resulting in two or more copies being sent to that person.
3707
The <list-reply> function, which by default is bound to ?L? in the index menu
3708
and pager, helps reduce the clutter by only replying to the known mailing list
3709
addresses instead of all recipients (except as specified by Mail-Followup-To,
3710
see below).
3391
3711
3392
3712
Mutt also supports the Mail-Followup-To header. When you send a message to a
3393
3713
list of recipients which includes one or several subscribed mailing lists, and
3394
3714
if the $followup_to option is set, mutt will generate a Mail-Followup-To header
3395
3715
which contains all the recipients to whom you send this message, but not your
3396
3716
address. This indicates that group-replies or list-replies (also known as
3397
``followups'') to this message should only be sent to the original recipients
3398
of the message, and not separately to you - you'll receive your copy through
3399
one of the mailing lists you are subscribed to.
3717
?followups?) to this message should only be sent to the original recipients of
3718
the message, and not separately to you - you'll receive your copy through one
3719
of the mailing lists you are subscribed to.
3400
3720
3401
3721
Conversely, when group-replying or list-replying to a message which has a
3402
3722
Mail-Followup-To header, mutt will respect this header if the
3404
3724
case also make sure that the reply goes to the mailing list, even if it's not
3405
3725
specified in the list of recipients in the Mail-Followup-To.
3406
3726
3407
Note that, when header editing is enabled, you can create a Mail-Followup-To
3408
header manually. Mutt will only auto-generate this header if it doesn't exist
3409
when you send the message.
3410
3411
The other method some mailing list admins use is to generate a ``Reply-To''
3412
field which points back to the mailing list address rather than the author of
3413
the message. This can create problems when trying to reply directly to the
3414
author in private, since most mail clients will automatically reply to the
3415
address given in the ``Reply-To'' field. Mutt uses the $reply_to variable to
3416
help decide which address to use. If set to ask-yes or ask-no, you will be
3417
prompted as to whether or not you would like to use the address given in the
3418
``Reply-To'' field, or reply directly to the address given in the ``From''
3419
field. When set to yes, the ``Reply-To'' field will be used when present.
3420
3421
The ``X-Label:'' header field can be used to further identify mailing lists or
3727
Note
3728
3729
When header editing is enabled, you can create a Mail-Followup-To header
3730
manually. Mutt will only auto-generate this header if it doesn't exist when you
3731
send the message.
3732
3733
The other method some mailing list admins use is to generate a ?Reply-To? field
3734
which points back to the mailing list address rather than the author of the
3735
message. This can create problems when trying to reply directly to the author
3736
in private, since most mail clients will automatically reply to the address
3737
given in the ?Reply-To? field. Mutt uses the $reply_to variable to help decide
3738
which address to use. If set to ask-yes or ask-no, you will be prompted as to
3739
whether or not you would like to use the address given in the ?Reply-To? field,
3740
or reply directly to the address given in the ?From? field. When set to yes,
3741
the ?Reply-To? field will be used when present.
3742
3743
The ?X-Label:? header field can be used to further identify mailing lists or
3422
3744
list subject matter (or just to annotate messages individually). The
3423
$index_format variable's ``%y'' and ``%Y'' escapes can be used to expand
3424
``X-Label:'' fields in the index, and Mutt's pattern-matcher can match regular
3425
expressions to ``X-Label:'' fields with the ``~y'' selector. ``X-Label:'' is
3426
not a standard message header field, but it can easily be inserted by procmail
3427
and other mail filtering agents.
3745
$index_format variable's ?%y? and ?%Y? escapes can be used to expand ?X-Label:?
3746
fields in the index, and Mutt's pattern-matcher can match regular expressions
3747
to ?X-Label:? fields with the ??y? selector. ?X-Label:? is not a standard
3748
message header field, but it can easily be inserted by procmail and other mail
3749
filtering agents.
3428
3750
3429
3751
Lastly, Mutt has the ability to sort the mailbox into threads. A thread is a
3430
3752
group of messages which all relate to the same subject. This is usually
3434
3756
because you can easily delete uninteresting threads and quickly find topics of
3435
3757
value.
3436
3758
3437
9. Editing threads
3759
9. Handling multiple folders
3760
3761
Mutt supports setups with multiple folders, allowing all of them to be
3762
monitored for new mail (see Section 14, ?Monitoring incoming mail? for
3763
details).
3764
3765
When in the index menu and being idle (also see $timeout), Mutt periodically
3766
checks for new mail in all folders which have been configured via the mailboxes
3767
command. The interval depends on the folder type: for local/IMAP folders it
3768
consults $mail_check and $pop_checkinterval for POP folders.
3769
3770
Outside the index menu the directory browser supports checking for new mail
3771
using the <check-new> function which is unbound by default. Pressing TAB will
3772
bring up a menu showing the files specified by the mailboxes command, and
3773
indicate which contain new messages. Mutt will automatically enter this mode
3774
when invoked from the command line with the -y option.
3775
3776
For the pager, index and directory browser menus, Mutt contains the
3777
<buffy-list> function (bound to ?.? by default) which will print a list of
3778
folders with new mail in the command line at the bottom of the screen.
3779
3780
For the index, by default Mutt displays the number of mailboxes with new mail
3781
in the status bar, please refer to the $index_format variable for details.
3782
3783
When changing folders, Mutt fills the prompt with the first folder from the
3784
mailboxes list containing new mail (if any), pressing space will cycle through
3785
folders with new mail.
3786
3787
10. Editing threads
3438
3788
3439
3789
Mutt has the ability to dynamically restructure threads that are broken either
3440
3790
by misconfigured software or bad behavior from some correspondents. This allows
3441
3791
to clean your mailboxes formats) from these annoyances which make it hard to
3442
3792
follow a discussion.
3443
3793
3444
9.1. Linking threads
3794
10.1. Linking threads
3445
3795
3446
3796
Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
3447
3797
"References:" headers when replying to a message. This results in broken
3448
3798
discussions because Mutt has not enough information to guess the correct
3449
3799
threading. You can fix this by tagging the reply, then moving to the parent
3450
message and using the ``link-threads'' function (bound to & by default). The
3800
message and using the <link-threads> function (bound to & by default). The
3451
3801
reply will then be connected to this "parent" message.
3452
3802
3453
3803
You can also connect multiple children at once, tagging them and using the
3454
3804
tag-prefix command (';') or the auto_tag option.
3455
3805
3456
9.2. Breaking threads
3806
10.2. Breaking threads
3457
3807
3458
3808
On mailing lists, some people are in the bad habit of starting a new discussion
3459
3809
by hitting "reply" to any message from the list and changing the subject to a
3460
totally unrelated one. You can fix such threads by using the ``break-thread''
3810
totally unrelated one. You can fix such threads by using the <break-thread>
3461
3811
function (bound by default to #), which will turn the subthread starting from
3462
3812
the current message into a whole different thread.
3463
3813
3464
10. Delivery Status Notification (DSN) Support
3814
11. Delivery Status Notification (DSN) Support
3465
3815
3466
3816
RFC1894 defines a set of MIME content types for relaying information about the
3467
status of electronic mail messages. These can be thought of as ``return
3468
receipts.''
3817
status of electronic mail messages. These can be thought of as ?return
3818
receipts.?
3469
3819
3470
3820
To support DSN, there are two variables. $dsn_notify is used to request
3471
3821
receipts for different results (such as failed message, message delivered,
3481
3831
For SMTP delivery using $smtp_url, it depends on the capabilities announced by
3482
3832
the server whether mutt will attempt to request DSN or not.
3483
3833
3484
11. Start a WWW Browser on URLs (EXTERNAL)
3834
12. Start a WWW Browser on URLs
3485
3835
3486
If a message contains URLs (unified resource locator = address in the WWW space
3487
like http://www.mutt.org/), it is efficient to get a menu with all the URLs and
3836
If a message contains URLs, it is efficient to get a menu with all the URLs and
3488
3837
start a WWW browser on one of them. This functionality is provided by the
3489
3838
external urlview program which can be retrieved at ftp://ftp.mutt.org/mutt/
3490
3839
contrib/ and the configuration commands:
3556
3905
menu for a message. The attachment menu displays a list of the attachments in a
3557
3906
message. From the attachment menu, you can save, print, pipe, delete, and view
3558
3907
attachments. You can apply these operations to a group of attachments at once,
3559
by tagging the attachments and by using the ``tag-prefix'' operator. You can
3560
also reply to the current message from this menu, and only the current
3561
attachment (or the attachments tagged) will be quoted in your reply. You can
3562
view attachments as text, or view them using the mailcap viewer definition.
3908
by tagging the attachments and by using the ?tag-prefix? operator. You can also
3909
reply to the current message from this menu, and only the current attachment
3910
(or the attachments tagged) will be quoted in your reply. You can view
3911
attachments as text, or view them using the mailcap viewer definition.
3563
3912
3564
Finally, you can apply the usual message-related functions (like resend-message
3565
, and the reply and forward functions) to attachments of type message/rfc822.
3913
Finally, you can apply the usual message-related functions (like
3914
<resend-message>, and the <reply> and <forward> functions) to attachments of
3915
type message/rfc822.
3566
3916
3567
3917
See the help on the attachment menu for more information.
3568
3918
3702
4052
text/html; lynx %s
3703
4053
3704
4054
In this case, lynx does not support viewing a file from stdin, so you must use
3705
the %s syntax. Note:Some older versions of lynx contain a bug where they will
3706
check the mailcap file for a viewer for text/html. They will find the line
3707
which calls lynx, and run it. This causes lynx to continuously spawn itself to
3708
view the object.
4055
the %s syntax.
4056
4057
Note
4058
4059
Some older versions of lynx contain a bug where they will check the mailcap
4060
file for a viewer for text/html. They will find the line which calls lynx, and
4061
run it. This causes lynx to continuously spawn itself to view the object.
3709
4062
3710
4063
On the other hand, maybe you don't want to use lynx interactively, you just
3711
4064
want to have it convert the text/html to text/plain, then you can use:
3819
4172
should be used. The command is defined with the command expansion rules
3820
4173
defined in the next section. If the command returns 0, then the test
3821
4174
passed, and Mutt uses this entry. If the command returns non-zero, then the
3822
test failed, and Mutt continues searching for the right entry. Note:the
3823
content-type must match before Mutt performs the test. For example:
4175
test failed, and Mutt continues searching for the right entry. Note that
4176
the content-type must match before Mutt performs the test. For example:
3824
4177
3825
4178
text/html; netscape -remote 'openURL(%s)' ; test=RunningX
3826
4179
text/html; lynx %s
3980
4333
application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
3981
4334
application/postscript; ps2ascii %s; copiousoutput
3982
4335
3983
``unauto_view'' can be used to remove previous entries from the autoview list.
4336
?unauto_view? can be used to remove previous entries from the autoview list.
3984
4337
This can be used with message-hook to autoview messages based on size, etc.
3985
``unauto_view *'' will remove all previous entries.
4338
?unauto_view *? will remove all previous entries.
3986
4339
3987
4340
5. MIME Multipart/Alternative
3988
4341
4021
4374
unattachments {+|-}disposition mime-type
4022
4375
attachments ?
4023
4376
4024
Disposition is the attachment's Content-disposition type -- either "inline" or
4025
"attachment". You can abbreviate this to I or A.
4377
Disposition is the attachment's Content-disposition type -- either inline or
4378
attachment. You can abbreviate this to I or A.
4026
4379
4027
Disposition is prefixed by either a + symbolor a - symbol. If it's a +, you're
4380
Disposition is prefixed by either a + symbol or a - symbol. If it's a +, you're
4028
4381
saying that you want to allow this disposition and MIME type to qualify. If
4029
4382
it's a -, you're saying that this disposition and MIME type is an exception to
4030
4383
previous + rules. There are examples below of how this is useful.
4031
4384
4032
4385
Mime-type is, unsurprisingly, the MIME type of the attachment you want to
4033
affect. A MIME type is always of the format "major/minor", where "major"
4034
describes the broad category of document you're looking at, and "minor"
4035
describes the specific type within that category. The major part of mim-type
4036
must be literal text (or the special token "*"), but the minor part may be a
4037
regular expression. (Therefore, "*/.*" matches any MIME type.)
4386
affect. A MIME type is always of the format major/minor, where major describes
4387
the broad category of document you're looking at, and minor describes the
4388
specific type within that category. The major part of mime-type must be literal
4389
text (or the special token ?*?), but the minor part may be a regular
4390
expression. (Therefore, ?*/.*? matches any MIME type.)
4038
4391
4039
4392
The MIME types you give to the attachments directive are a kind of pattern.
4040
4393
When you use the attachments directive, the patterns you specify are added to a
4046
4399
Some examples might help to illustrate. The examples that are not commented out
4047
4400
define the default configuration of the lists.
4048
4401
4402
Example 5.1. Attachment counting
4403
4049
4404
## Removing a pattern from a list removes that pattern literally. It
4050
4405
## does not remove any type matching the pattern.
4051
4406
##
4093
4448
attachments -A message/external-body
4094
4449
attachments -I message/external-body
4095
4450
4096
"attachments ?" will list your current settings in Muttrc format, so that it
4097
can be pasted elsewhere.
4451
4452
Entering the command ?attachments ?? as a command will list your current
4453
settings in Muttrc format, so that it can be pasted elsewhere.
4098
4454
4099
4455
7. MIME Lookup
4100
4456
4144
4500
4145
4501
Mutt supports several of optional features which can be enabled or disabled at
4146
4502
compile-time by giving the configure script certain arguments. These are listed
4147
in the ``Optional features'' section of the configure --help output.
4503
in the ?Optional features? section of the configure --help output.
4148
4504
4149
4505
Which features are enabled or disabled can later be determined from the output
4150
of mutt -v. If a compile option starts with ``+'' it is enabled and disabled if
4151
prefixed with ``-''. For example, if mutt was compiled using GnuTLS for
4152
encrypted communication instead of OpenSSL, mutt -v would contain:
4506
of mutt -v. If a compile option starts with ?+? it is enabled and disabled if
4507
prefixed with ?-?. For example, if mutt was compiled using GnuTLS for encrypted
4508
communication instead of OpenSSL, mutt -v would contain:
4153
4509
4154
4510
-USE_SSL_OPENSSL +USE_SSL_GNUTLS
4155
4511
4162
4518
proto[s]://[username[:password]@]server[:port]/[path]
4163
4519
4164
4520
proto is the communication protocol: imap for IMAP, pop for POP3 and smtp for
4165
SMTP. If ``s'' for ``secure communication'' is appended, mutt will attempt to
4521
SMTP. If ?s? for ?secure communication? is appended, mutt will attempt to
4166
4522
establish an encrypted communication using SSL or TLS. If no explicit port is
4167
4523
given, mutt will use the system's default for the given protocol.
4168
4524
4169
4525
Since all protocols by mutt support authentication, the username may be given
4170
directly in the URL instead of using the pop_user or imap_user variables. A
4171
password can be given, too but is not recommended if the URL is specified in a
4172
configuration file on disk.
4526
directly in the URL instead of using the pop_user or imap_user variables. It
4527
may contain the ?@? symbol being used by many mail systems as part of the login
4528
name. A password can be given, too but is not recommended if the URL is
4529
specified in a configuration file on disk.
4173
4530
4174
4531
The optional path is only relevant for IMAP.
4175
4532
4177
4534
the server: imap://imapserver:port/INBOX. You can also specify different
4178
4535
username for each folder: imap://username@imapserver[:port]/INBOX or imap://
4179
4536
username2@imapserver[:port]/path/to/folder. Replacing imap:// by imaps:// would
4180
make mutt attempt to conect using SSL or TLS on a different port to encrypt the
4181
communication.
4537
make mutt attempt to connect using SSL or TLS on a different port to encrypt
4538
the communication.
4182
4539
4183
4540
2. SSL/TLS Support
4184
4541
4186
4543
compiled with support for SSL or TLS using either OpenSSL or GnuTLS ( by
4187
4544
running the configure script with the --enable-ssl=... option for OpenSSL or
4188
4545
--enable-gnutls=... for GnuTLS). Mutt can then attempt to encrypt communication
4189
with remote servers if these protocols are suffixed with ``s'' for ``secure
4190
communication''.
4546
with remote servers if these protocols are suffixed with ?s? for ?secure
4547
communication?.
4191
4548
4192
4549
3. POP3 Support
4193
4550
4196
4553
remote POP3 server and fetch mail for local browsing.
4197
4554
4198
4555
Remote POP3 servers can be accessed using URLs with the pop protocol for
4199
unencrypted and pops for encrypted communication, see Section 1.2, "URL syntax"
4556
unencrypted and pops for encrypted communication, see Section 1.2, ?URL syntax?
4200
4557
for details.
4201
4558
4202
4559
Polling for new mail is more expensive over POP3 than locally. For this reason
4203
4560
the frequency at which Mutt will check for mail remotely can be controlled by
4204
4561
the $pop_checkinterval variable, which defaults to every 60 seconds.
4205
4562
4206
Another way to access your POP3 mail is the fetch-mail function (default: G).
4563
Another way to access your POP3 mail is the <fetch-mail$ function (default: G).
4207
4564
It allows to connect to $pop_host, fetch all your new mail and place it in the
4208
4565
local $spoolfile. After this point, Mutt runs exactly as if the mail had always
4209
4566
been local.
4210
4567
4211
Note: If you only need to fetch all messages to a local mailbox you should
4212
consider using a specialized program, such as fetchmail, getmail or similar.
4568
Note
4569
4570
If you only need to fetch all messages to a local mailbox you should consider
4571
using a specialized program, such as fetchmail, getmail or similar.
4213
4572
4214
4573
4. IMAP Support
4215
4574
4217
4576
the --enable-imap flag), it has the ability to work with folders located on a
4218
4577
remote IMAP server.
4219
4578
4220
You can access the remote inbox by selecting the folder by its URL (see Section
4221
1.2, "URL syntax" for details) using the imap or imaps protocol. Alternatively,
4222
a pine-compatible notation is also supported, ie {[username@]imapserver[:port]
4223
[/ssl]}path/to/folder
4579
You can access the remote inbox by selecting the folder by its URL (see
4580
Section 1.2, ?URL syntax? for details) using the imap or imaps protocol.
4581
Alternatively, a pine-compatible notation is also supported, ie {[username@]
4582
imapserver[:port][/ssl]}path/to/folder
4224
4583
4225
Note that not all servers use ``/'' as the hierarchy separator. Mutt should
4584
Note that not all servers use ?/? as the hierarchy separator. Mutt should
4226
4585
correctly notice which separator is being used by the server and convert paths
4227
4586
accordingly.
4228
4587
4238
4597
4239
4598
with relatively good results over my slow modem line.
4240
4599
4600
Note
4601
4241
4602
Note that if you are using mbox as the mail store on UW servers prior to
4242
4603
v12.250, the server has been reported to disconnect a client if another client
4243
4604
selects the same folder.
4247
4608
As of version 1.2, mutt supports browsing mailboxes on an IMAP server. This is
4248
4609
mostly the same as the local file browser, with the following differences:
4249
4610
4250
● In lieu of file permissions, mutt displays the string "IMAP", possibly
4611
* In lieu of file permissions, mutt displays the string "IMAP", possibly
4251
4612
followed by the symbol "+", indicating that the entry contains both
4252
4613
messages and subfolders. On Cyrus-like servers folders will often contain
4253
4614
both messages and subfolders.
4254
4615
4255
● For the case where an entry can contain both messages and subfolders, the
4616
* For the case where an entry can contain both messages and subfolders, the
4256
4617
selection key (bound to enter by default) will choose to descend into the
4257
4618
subfolder view. If you wish to view the messages in that folder, you must
4258
4619
use view-file instead (bound to space by default).
4259
4620
4260
● You can create, delete and rename mailboxes with the create-mailbox,
4621
* You can create, delete and rename mailboxes with the create-mailbox,
4261
4622
delete-mailbox, and rename-mailbox commands (default bindings: C, d and r,
4262
4623
respectively). You may also subscribe and unsubscribe to mailboxes
4263
4624
(normally these are bound to s and u, respectively).
4284
4645
4285
4646
There are a few variables which control authentication:
4286
4647
4287
● $imap_user - controls the username under which you request authentication
4648
* $imap_user - controls the username under which you request authentication
4288
4649
on the IMAP server, for all authenticators. This is overridden by an
4289
4650
explicit username in the mailbox path (ie by using a mailbox name of the
4290
4651
form {user@host}).
4291
4652
4292
● $imap_pass - a password which you may preset, used by all authentication
4653
* $imap_pass - a password which you may preset, used by all authentication
4293
4654
methods where a password is needed.
4294
4655
4295
● $imap_authenticators - a colon-delimited list of IMAP authentication
4656
* $imap_authenticators - a colon-delimited list of IMAP authentication
4296
4657
methods to try, in the order you wish to try them. If specified, this
4297
4658
overrides mutt's default (attempt everything, in the order listed above).
4298
4659
4306
4667
SMTP server to deliver messages; if it is unset, mutt will use the program
4307
4668
specified by $sendmail.
4308
4669
4309
For details on the URL syntax, please see Section 1.2, "URL syntax".
4670
For details on the URL syntax, please see Section 1.2, ?URL syntax?.
4310
4671
4311
4672
The built-in SMTP support supports encryption (the smtps protocol using SSL or
4312
4673
TLS) as well as SMTP authentication using SASL. The authentication mechanisms
4319
4680
may find managing all the authentication settings inconvenient and error-prone.
4320
4681
The account-hook command may help. This hook works like folder-hook but is
4321
4682
invoked whenever you access a remote mailbox (including inside the folder
4322
browser), not just when you open the mailbox.
4683
browser), not just when you open the mailbox which includes (for example)
4684
polling for new mail, storing Fcc messages and saving messages to a folder. As
4685
a consequence, account-hook should only be used to set connection-related
4686
settings such as passwords or tunnel commands but not settings such as sender
4687
address or name (because in general it should be considered unpredictable which
4688
account-hook was last used).
4323
4689
4324
4690
Some examples:
4325
4691
4330
4696
4331
4697
7. Local caching
4332
4698
4333
Mutt contains two types of local caching: (1) the so-called ``header caching''
4334
and (2) the so-called ``body caching'' which are both described in this
4335
section.
4699
Mutt contains two types of local caching: (1) the so-called ?header caching?
4700
and (2) the so-called ?body caching? which are both described in this section.
4336
4701
4337
4702
Header caching is optional as it depends on external libraries, body caching is
4338
4703
always enabled if mutt is compiled with POP and/or IMAP support as these use it
4349
4714
4350
4715
Header caching can be enabled via the configure script and the --enable-hcache
4351
4716
option. It's not turned on by default because external database libraries are
4352
required: one of qdbm, gdbm or bdb must be present.
4717
required: one of tokyocabinet, qdbm, gdbm or bdb must be present.
4353
4718
4354
4719
If enabled, $header_cache can be used to either point to a file or a directory.
4355
4720
If set to point to a file, one database file for all folders will be used
4378
4743
4379
4744
For configuration, the variable $message_cachedir must point to a directory.
4380
4745
There, mutt will create a hierarchy of subdirectories named like:
4381
proto:user@hostname where proto is either ``pop'' or ``imap.'' Within there for
4746
proto:user@hostname where proto is either ?pop? or ?imap.? Within there for
4382
4747
each folder, mutt stores messages in single files (just like Maildir) so that
4383
4748
with manual symlink creation these cache directories can be examined with mutt
4384
4749
as read-only Maildir folders.
4403
4768
4404
4769
8. Exact address generation
4405
4770
4406
Mutt supports the ``Name <user@host>'' address syntax for reading and writing
4407
messages, the older ``user@host (Name)'' syntax is only supported when reading
4771
Mutt supports the ?Name <user@host>? address syntax for reading and writing
4772
messages, the older ?user@host (Name)? syntax is only supported when reading
4408
4773
messages. The --enable-exact-address switch can be given to configure to build
4409
4774
it with write-support for the latter syntax. EXACT_ADDRESS in the output of
4410
4775
mutt -v indicates whether it's supported.
4463
4828
4464
4829
When searching mailboxes either via a search or a limit action, for some
4465
4830
patterns mutt distinguishes between regular expression and string searches. For
4466
regular expressions, patterns are prefixed with ``~'' and with ``='' for string
4831
regular expressions, patterns are prefixed with ??? and with ?=? for string
4467
4832
searches.
4468
4833
4469
4834
Even though a regular expression search is fast, it's several times slower than
4470
a pure string search which is noticable especially on large folders. As a
4835
a pure string search which is noticeable especially on large folders. As a
4471
4836
consequence, a string search should be used instead of a regular expression
4472
4837
search if the user already knows enough about the search pattern.
4473
4838
4474
4839
For example, when limiting a large folder to all messages sent to or by an
4475
4840
author, it's much faster to search for the initial part of an e-mail address
4476
via =Luser@ instead of ~Luser@. This is especially true for searching message
4841
via =Luser@ instead of ?Luser@. This is especially true for searching message
4477
4842
bodies since a larger amount of input has to be searched.
4478
4843
4479
4844
Please note that string search is an exact case-sensitive search while a
4581
4946
3.91. imap_pass
4582
4947
3.92. imap_passive
4583
4948
3.93. imap_peek
4584
3.94. imap_servernoise
4585
3.95. imap_user
4586
3.96. implicit_autoview
4587
3.97. include
4588
3.98. include_onlyfirst
4589
3.99. indent_string
4590
3.100. index_format
4591
3.101. ispell
4592
3.102. keep_flagged
4593
3.103. locale
4594
3.104. mail_check
4595
3.105. mailcap_path
4596
3.106. mailcap_sanitize
4597
3.107. header_cache
4598
3.108. maildir_header_cache_verify
4599
3.109. header_cache_pagesize
4600
3.110. header_cache_compress
4601
3.111. maildir_trash
4602
3.112. mark_old
4603
3.113. markers
4604
3.114. mask
4605
3.115. mbox
4606
3.116. mbox_type
4607
3.117. metoo
4608
3.118. menu_context
4609
3.119. menu_move_off
4610
3.120. menu_scroll
4611
3.121. meta_key
4612
3.122. mh_purge
4613
3.123. mh_seq_flagged
4614
3.124. mh_seq_replied
4615
3.125. mh_seq_unseen
4616
3.126. mime_forward
4617
3.127. mime_forward_decode
4618
3.128. mime_forward_rest
4619
3.129. mix_entry_format
4620
3.130. mixmaster
4621
3.131. move
4622
3.132. message_cachedir
4623
3.133. message_cache_clean
4624
3.134. message_format
4625
3.135. narrow_tree
4626
3.136. net_inc
4627
3.137. pager
4628
3.138. pager_context
4629
3.139. pager_format
4630
3.140. pager_index_lines
4631
3.141. pager_stop
4632
3.142. crypt_autosign
4633
3.143. crypt_autoencrypt
4634
3.144. pgp_ignore_subkeys
4635
3.145. crypt_replyencrypt
4636
3.146. crypt_replysign
4637
3.147. crypt_replysignencrypted
4638
3.148. crypt_timestamp
4639
3.149. pgp_use_gpg_agent
4640
3.150. crypt_verify_sig
4641
3.151. smime_is_default
4642
3.152. smime_ask_cert_label
4643
3.153. smime_decrypt_use_default_key
4644
3.154. pgp_entry_format
4645
3.155. pgp_good_sign
4646
3.156. pgp_check_exit
4647
3.157. pgp_long_ids
4648
3.158. pgp_retainable_sigs
4649
3.159. pgp_autoinline
4650
3.160. pgp_replyinline
4651
3.161. pgp_show_unusable
4652
3.162. pgp_sign_as
4653
3.163. pgp_strict_enc
4654
3.164. pgp_timeout
4655
3.165. pgp_sort_keys
4656
3.166. pgp_mime_auto
4657
3.167. pgp_auto_decode
4658
3.168. pgp_decode_command
4659
3.169. pgp_getkeys_command
4660
3.170. pgp_verify_command
4661
3.171. pgp_decrypt_command
4662
3.172. pgp_clearsign_command
4663
3.173. pgp_sign_command
4664
3.174. pgp_encrypt_sign_command
4665
3.175. pgp_encrypt_only_command
4666
3.176. pgp_import_command
4667
3.177. pgp_export_command
4668
3.178. pgp_verify_key_command
4669
3.179. pgp_list_secring_command
4670
3.180. pgp_list_pubring_command
4671
3.181. forward_decrypt
4672
3.182. smime_timeout
4673
3.183. smime_encrypt_with
4674
3.184. smime_keys
4675
3.185. smime_ca_location
4676
3.186. smime_certificates
4677
3.187. smime_decrypt_command
4678
3.188. smime_verify_command
4679
3.189. smime_verify_opaque_command
4680
3.190. smime_sign_command
4681
3.191. smime_sign_opaque_command
4682
3.192. smime_encrypt_command
4683
3.193. smime_pk7out_command
4684
3.194. smime_get_cert_command
4685
3.195. smime_get_signer_cert_command
4686
3.196. smime_import_cert_command
4687
3.197. smime_get_cert_email_command
4688
3.198. smime_default_key
4689
3.199. ssl_client_cert
4690
3.200. ssl_force_tls
4691
3.201. ssl_starttls
4692
3.202. certificate_file
4693
3.203. ssl_usesystemcerts
4694
3.204. entropy_file
4695
3.205. ssl_use_sslv2
4696
3.206. ssl_use_sslv3
4697
3.207. ssl_use_tlsv1
4698
3.208. ssl_min_dh_prime_bits
4699
3.209. ssl_ca_certificates_file
4700
3.210. pipe_split
4701
3.211. pipe_decode
4702
3.212. pipe_sep
4703
3.213. pop_authenticators
4704
3.214. pop_auth_try_all
4705
3.215. pop_checkinterval
4706
3.216. pop_delete
4707
3.217. pop_host
4708
3.218. pop_last
4709
3.219. pop_reconnect
4710
3.220. pop_user
4711
3.221. pop_pass
4712
3.222. post_indent_string
4713
3.223. postpone
4714
3.224. postponed
4715
3.225. preconnect
4716
3.226. print
4717
3.227. print_command
4718
3.228. print_decode
4719
3.229. print_split
4720
3.230. prompt_after
4721
3.231. query_command
4722
3.232. query_format
4723
3.233. quit
4724
3.234. quote_regexp
4725
3.235. read_inc
4726
3.236. read_only
4727
3.237. realname
4728
3.238. recall
4729
3.239. record
4730
3.240. reply_regexp
4731
3.241. reply_self
4732
3.242. reply_to
4733
3.243. resolve
4734
3.244. reverse_alias
4735
3.245. reverse_name
4736
3.246. reverse_realname
4737
3.247. rfc2047_parameters
4738
3.248. save_address
4739
3.249. save_empty
4740
3.250. save_history
4741
3.251. save_name
4742
3.252. score
4743
3.253. score_threshold_delete
4744
3.254. score_threshold_flag
4745
3.255. score_threshold_read
4746
3.256. send_charset
4747
3.257. sendmail
4748
3.258. sendmail_wait
4749
3.259. shell
4750
3.260. sig_dashes
4751
3.261. sig_on_top
4752
3.262. signature
4753
3.263. simple_search
4754
3.264. smart_wrap
4755
3.265. smileys
4756
3.266. sleep_time
4757
3.267. smtp_authenticators
4758
3.268. smtp_pass
4759
3.269. smtp_url
4760
3.270. sort
4761
3.271. sort_alias
4762
3.272. sort_aux
4763
3.273. sort_browser
4764
3.274. sort_re
4765
3.275. spam_separator
4766
3.276. spoolfile
4767
3.277. status_chars
4768
3.278. status_format
4769
3.279. status_on_top
4770
3.280. strict_threads
4771
3.281. suspend
4772
3.282. text_flowed
4773
3.283. thread_received
4774
3.284. thorough_search
4775
3.285. tilde
4776
3.286. time_inc
4777
3.287. timeout
4778
3.288. tmpdir
4779
3.289. to_chars
4780
3.290. tunnel
4781
3.291. use_8bitmime
4782
3.292. use_domain
4783
3.293. use_envelope_from
4784
3.294. use_from
4785
3.295. use_idn
4786
3.296. use_ipv6
4787
3.297. user_agent
4788
3.298. visual
4789
3.299. wait_key
4790
3.300. weed
4791
3.301. wrap
4792
3.302. wrap_search
4793
3.303. wrapmargin
4794
3.304. write_inc
4795
3.305. write_bcc
4949
3.94. imap_pipeline_depth
4950
3.95. imap_servernoise
4951
3.96. imap_user
4952
3.97. implicit_autoview
4953
3.98. include
4954
3.99. include_onlyfirst
4955
3.100. indent_string
4956
3.101. index_format
4957
3.102. ispell
4958
3.103. keep_flagged
4959
3.104. locale
4960
3.105. mail_check
4961
3.106. mailcap_path
4962
3.107. mailcap_sanitize
4963
3.108. header_cache
4964
3.109. maildir_header_cache_verify
4965
3.110. header_cache_pagesize
4966
3.111. header_cache_compress
4967
3.112. maildir_trash
4968
3.113. mark_old
4969
3.114. markers
4970
3.115. mask
4971
3.116. mbox
4972
3.117. mbox_type
4973
3.118. metoo
4974
3.119. menu_context
4975
3.120. menu_move_off
4976
3.121. menu_scroll
4977
3.122. meta_key
4978
3.123. mh_purge
4979
3.124. mh_seq_flagged
4980
3.125. mh_seq_replied
4981
3.126. mh_seq_unseen
4982
3.127. mime_forward
4983
3.128. mime_forward_decode
4984
3.129. mime_forward_rest
4985
3.130. mix_entry_format
4986
3.131. mixmaster
4987
3.132. move
4988
3.133. message_cachedir
4989
3.134. message_cache_clean
4990
3.135. message_format
4991
3.136. narrow_tree
4992
3.137. net_inc
4993
3.138. pager
4994
3.139. pager_context
4995
3.140. pager_format
4996
3.141. pager_index_lines
4997
3.142. pager_stop
4998
3.143. crypt_autosign
4999
3.144. crypt_autoencrypt
5000
3.145. pgp_ignore_subkeys
5001
3.146. crypt_replyencrypt
5002
3.147. crypt_replysign
5003
3.148. crypt_replysignencrypted
5004
3.149. crypt_timestamp
5005
3.150. pgp_use_gpg_agent
5006
3.151. crypt_verify_sig
5007
3.152. smime_is_default
5008
3.153. smime_ask_cert_label
5009
3.154. smime_decrypt_use_default_key
5010
3.155. pgp_entry_format
5011
3.156. pgp_good_sign
5012
3.157. pgp_check_exit
5013
3.158. pgp_long_ids
5014
3.159. pgp_retainable_sigs
5015
3.160. pgp_autoinline
5016
3.161. pgp_replyinline
5017
3.162. pgp_show_unusable
5018
3.163. pgp_sign_as
5019
3.164. pgp_strict_enc
5020
3.165. pgp_timeout
5021
3.166. pgp_sort_keys
5022
3.167. pgp_mime_auto
5023
3.168. pgp_auto_decode
5024
3.169. pgp_decode_command
5025
3.170. pgp_getkeys_command
5026
3.171. pgp_verify_command
5027
3.172. pgp_decrypt_command
5028
3.173. pgp_clearsign_command
5029
3.174. pgp_sign_command
5030
3.175. pgp_encrypt_sign_command
5031
3.176. pgp_encrypt_only_command
5032
3.177. pgp_import_command
5033
3.178. pgp_export_command
5034
3.179. pgp_verify_key_command
5035
3.180. pgp_list_secring_command
5036
3.181. pgp_list_pubring_command
5037
3.182. forward_decrypt
5038
3.183. smime_timeout
5039
3.184. smime_encrypt_with
5040
3.185. smime_keys
5041
3.186. smime_ca_location
5042
3.187. smime_certificates
5043
3.188. smime_decrypt_command
5044
3.189. smime_verify_command
5045
3.190. smime_verify_opaque_command
5046
3.191. smime_sign_command
5047
3.192. smime_sign_opaque_command
5048
3.193. smime_encrypt_command
5049
3.194. smime_pk7out_command
5050
3.195. smime_get_cert_command
5051
3.196. smime_get_signer_cert_command
5052
3.197. smime_import_cert_command
5053
3.198. smime_get_cert_email_command
5054
3.199. smime_default_key
5055
3.200. ssl_client_cert
5056
3.201. ssl_force_tls
5057
3.202. ssl_starttls
5058
3.203. certificate_file
5059
3.204. ssl_usesystemcerts
5060
3.205. entropy_file
5061
3.206. ssl_use_sslv2
5062
3.207. ssl_use_sslv3
5063
3.208. ssl_use_tlsv1
5064
3.209. ssl_min_dh_prime_bits
5065
3.210. ssl_ca_certificates_file
5066
3.211. pipe_split
5067
3.212. pipe_decode
5068
3.213. pipe_sep
5069
3.214. pop_authenticators
5070
3.215. pop_auth_try_all
5071
3.216. pop_checkinterval
5072
3.217. pop_delete
5073
3.218. pop_host
5074
3.219. pop_last
5075
3.220. pop_reconnect
5076
3.221. pop_user
5077
3.222. pop_pass
5078
3.223. post_indent_string
5079
3.224. postpone
5080
3.225. postponed
5081
3.226. preconnect
5082
3.227. print
5083
3.228. print_command
5084
3.229. print_decode
5085
3.230. print_split
5086
3.231. prompt_after
5087
3.232. query_command
5088
3.233. query_format
5089
3.234. quit
5090
3.235. quote_regexp
5091
3.236. read_inc
5092
3.237. read_only
5093
3.238. realname
5094
3.239. recall
5095
3.240. record
5096
3.241. reply_regexp
5097
3.242. reply_self
5098
3.243. reply_to
5099
3.244. resolve
5100
3.245. reverse_alias
5101
3.246. reverse_name
5102
3.247. reverse_realname
5103
3.248. rfc2047_parameters
5104
3.249. save_address
5105
3.250. save_empty
5106
3.251. save_history
5107
3.252. save_name
5108
3.253. score
5109
3.254. score_threshold_delete
5110
3.255. score_threshold_flag
5111
3.256. score_threshold_read
5112
3.257. send_charset
5113
3.258. sendmail
5114
3.259. sendmail_wait
5115
3.260. shell
5116
3.261. sig_dashes
5117
3.262. sig_on_top
5118
3.263. signature
5119
3.264. simple_search
5120
3.265. smart_wrap
5121
3.266. smileys
5122
3.267. sleep_time
5123
3.268. smtp_authenticators
5124
3.269. smtp_pass
5125
3.270. smtp_url
5126
3.271. sort
5127
3.272. sort_alias
5128
3.273. sort_aux
5129
3.274. sort_browser
5130
3.275. sort_re
5131
3.276. spam_separator
5132
3.277. spoolfile
5133
3.278. status_chars
5134
3.279. status_format
5135
3.280. status_on_top
5136
3.281. strict_threads
5137
3.282. suspend
5138
3.283. text_flowed
5139
3.284. thread_received
5140
3.285. thorough_search
5141
3.286. tilde
5142
3.287. time_inc
5143
3.288. timeout
5144
3.289. tmpdir
5145
3.290. to_chars
5146
3.291. tunnel
5147
3.292. use_8bitmime
5148
3.293. use_domain
5149
3.294. use_envelope_from
5150
3.295. use_from
5151
3.296. use_idn
5152
3.297. use_ipv6
5153
3.298. user_agent
5154
3.299. visual
5155
3.300. wait_key
5156
3.301. weed
5157
3.302. wrap
5158
3.303. wrap_search
5159
3.304. wrapmargin
5160
3.305. write_inc
5161
3.306. write_bcc
4796
5162
4797
5163
4. Functions
4798
5164
4799
4.1. generic
4800
4.2. index
4801
4.3. pager
4802
4.4. alias
4803
4.5. query
4804
4.6. attach
4805
4.7. compose
4806
4.8. postpone
4807
4.9. browser
4808
4.10. pgp
4809
4.11. smime
4810
4.12. mix
4811
4.13. editor
5165
4.1. generic menu
5166
4.2. index menu
5167
4.3. pager menu
5168
4.4. alias menu
5169
4.5. query menu
5170
4.6. attach menu
5171
4.7. compose menu
5172
4.8. postpone menu
5173
4.9. browser menu
5174
4.10. pgp menu
5175
4.11. smime menu
5176
4.12. mix menu
5177
4.13. editor menu
4812
5178
4813
5179
1. Command line options
4814
5180
4818
5184
4819
5185
Table 8.1. Command line options
4820
5186
4821
┌──────┬──────────────────────────────────────────────────────────────────────┐
4822
│Option│ Description │
4823
├──────┼──────────────────────────────────────────────────────────────────────┤
4824
│-A │expand an alias │
4825
├──────┼──────────────────────────────────────────────────────────────────────┤
4826
│-a │attach a file to a message │
4827
├──────┼──────────────────────────────────────────────────────────────────────┤
4828
│-b │specify a blind carbon-copy (BCC) address │
4829
├──────┼──────────────────────────────────────────────────────────────────────┤
4830
│-c │specify a carbon-copy (Cc) address │
4831
├──────┼──────────────────────────────────────────────────────────────────────┤
4832
│-D │print the value of all mutt variables to stdout │
4833
├──────┼──────────────────────────────────────────────────────────────────────┤
4834
│-e │specify a config command to be run after initialization files are read│
4835
├──────┼──────────────────────────────────────────────────────────────────────┤
4836
│-f │specify a mailbox to load │
4837
├──────┼──────────────────────────────────────────────────────────────────────┤
4838
│-F │specify an alternate file to read initialization commands │
4839
├──────┼──────────────────────────────────────────────────────────────────────┤
4840
│-h │print help on command line options │
4841
├──────┼──────────────────────────────────────────────────────────────────────┤
4842
│-H │specify a draft file from which to read a header and body │
4843
├──────┼──────────────────────────────────────────────────────────────────────┤
4844
│-i │specify a file to include in a message composition │
4845
├──────┼──────────────────────────────────────────────────────────────────────┤
4846
│-m │specify a default mailbox type │
4847
├──────┼──────────────────────────────────────────────────────────────────────┤
4848
│-n │do not read the system Muttrc │
4849
├──────┼──────────────────────────────────────────────────────────────────────┤
4850
│-p │recall a postponed message │
4851
├──────┼──────────────────────────────────────────────────────────────────────┤
4852
│-Q │query a configuration variable │
4853
├──────┼──────────────────────────────────────────────────────────────────────┤
4854
│-R │open mailbox in read-only mode │
4855
├──────┼──────────────────────────────────────────────────────────────────────┤
4856
│-s │specify a subject (enclose in quotes if it contains spaces) │
4857
├──────┼──────────────────────────────────────────────────────────────────────┤
4858
│-v │show version number and compile-time definitions │
4859
├──────┼──────────────────────────────────────────────────────────────────────┤
4860
│-x │simulate the mailx(1) compose mode │
4861
├──────┼──────────────────────────────────────────────────────────────────────┤
4862
│-y │show a menu containing the files specified by the mailboxes command │
4863
├──────┼──────────────────────────────────────────────────────────────────────┤
4864
│-z │exit immediately if there are no messages in the mailbox │
4865
├──────┼──────────────────────────────────────────────────────────────────────┤
4866
│-Z │open the first folder with new message,exit immediately if none │
4867
└──────┴──────────────────────────────────────────────────────────────────────┘
5187
+-----------------------------------------------------------------------------+
5188
|Option| Description |
5189
|------+----------------------------------------------------------------------|
5190
|-A |expand an alias |
5191
|------+----------------------------------------------------------------------|
5192
|-a |attach a file to a message |
5193
|------+----------------------------------------------------------------------|
5194
|-b |specify a blind carbon-copy (BCC) address |
5195
|------+----------------------------------------------------------------------|
5196
|-c |specify a carbon-copy (Cc) address |
5197
|------+----------------------------------------------------------------------|
5198
|-D |print the value of all mutt variables to stdout |
5199
|------+----------------------------------------------------------------------|
5200
|-e |specify a config command to be run after initialization files are read|
5201
|------+----------------------------------------------------------------------|
5202
|-f |specify a mailbox to load |
5203
|------+----------------------------------------------------------------------|
5204
|-F |specify an alternate file to read initialization commands |
5205
|------+----------------------------------------------------------------------|
5206
|-h |print help on command line options |
5207
|------+----------------------------------------------------------------------|
5208
|-H |specify a draft file from which to read a header and body |
5209
|------+----------------------------------------------------------------------|
5210
|-i |specify a file to include in a message composition |
5211
|------+----------------------------------------------------------------------|
5212
|-m |specify a default mailbox type |
5213
|------+----------------------------------------------------------------------|
5214
|-n |do not read the system Muttrc |
5215
|------+----------------------------------------------------------------------|
5216
|-p |recall a postponed message |
5217
|------+----------------------------------------------------------------------|
5218
|-Q |query a configuration variable |
5219
|------+----------------------------------------------------------------------|
5220
|-R |open mailbox in read-only mode |
5221
|------+----------------------------------------------------------------------|
5222
|-s |specify a subject (enclose in quotes if it contains spaces) |
5223
|------+----------------------------------------------------------------------|
5224
|-v |show version number and compile-time definitions |
5225
|------+----------------------------------------------------------------------|
5226
|-x |simulate the mailx(1) compose mode |
5227
|------+----------------------------------------------------------------------|
5228
|-y |show a menu containing the files specified by the mailboxes command |
5229
|------+----------------------------------------------------------------------|
5230
|-z |exit immediately if there are no messages in the mailbox |
5231
|------+----------------------------------------------------------------------|
5232
|-Z |open the first folder with new message,exit immediately if none |
5233
+-----------------------------------------------------------------------------+
4868
5234
4869
5235
4870
5236
To read messages in a mailbox
4871
5237
4872
mutt [ -nz ] [ -F muttrc ] [ -m type ] [ -f mailbox ]
5238
mutt [-nz] [-F muttrc ] [-m type ] [-f mailbox ]
4873
5239
4874
5240
To compose a new message
4875
5241
4876
mutt [ -n ] [ -F muttrc ] [ -a file ] [ -c address ] [ -i filename ] [ -s
4877
subject ] [ [ file ... ] -- ] address [ address ... ]
5242
mutt [-n] [-F muttrc ] [-a file ] [-c address ] [-i filename ] [-s subject ] [
5243
[ file ...] -- ] address [ address ...]
4878
5244
4879
Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect
5245
Mutt also supports a ?batch? mode to send prepared messages. Simply redirect
4880
5246
input from the file you wish to send. For example,
4881
5247
4882
mutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat
5248
mutt -s "data set for run #2" professor@bigschool.edu < ?/run2.dat
4883
5249
4884
This command will send a message to ``professor@bigschool.edu'' with a subject
4885
of ``data set for run #2''. In the body of the message will be the contents of
4886
the file ``~/run2.dat''.
5250
This command will send a message to ?professor@bigschool.edu? with a subject of
5251
?data set for run #2?. In the body of the message will be the contents of the
5252
file ??/run2.dat?.
4887
5253
4888
5254
All files passed with -a file will be attached as a MIME part to the message.
4889
To attach several files, use ``--'' to separate files and recipient addresses:
5255
To attach several files, use ?--? to separate files and recipient addresses:
4890
5256
mutt -a *.png -- some@one.org
4891
5257
4892
5258
2. Configuration Commands
4893
5259
4894
5260
The following are the commands understood by mutt.
4895
5261
4896
● account-hookpatterncommand
4897
4898
● alias [ -groupname [ ... ] ] keyaddress [ , address, ... ]
4899
4900
● unalias [ * | key ... ]
4901
4902
● alternates [ -groupname [ ... ] ] regexp [ regexp ... ]
4903
4904
● unalternates [ * | regexp ... ]
4905
4906
● alternative-ordermimetype [ mimetype ... ]
4907
4908
● unalternative-ordermimetype [ mimetype ... ]
4909
4910
● auto_viewmimetype [ mimetype ... ]
4911
4912
● unauto_viewmimetype [ mimetype ... ]
4913
4914
● bindmapkeyfunction
4915
4916
● charset-hookaliascharset
4917
4918
● iconv-hookcharsetlocal-charset
4919
4920
● colorobjectforegroundbackground [ regexp ]
4921
4922
● uncolorindexpattern [ pattern ... ]
4923
4924
● execfunction [ function ... ]
4925
4926
● fcc-hookpatternmailbox
4927
4928
● fcc-save-hookpatternmailbox
4929
4930
● folder-hookpatterncommand
4931
4932
● hdr_orderheader [ header ... ]
4933
4934
● unhdr_orderheader [ header ... ]
4935
4936
● ignorepattern [ pattern ... ]
4937
4938
● unignorepattern [ pattern ... ]
4939
4940
● lists [ -groupname [ ... ] ] regexp [ regexp ... ]
4941
4942
● unlistsregexp [ regexp ... ]
4943
4944
● macromenukeysequence [ description ]
4945
4946
● mailboxesfilename [ filename ... ]
4947
4948
● mbox-hookpatternmailbox
4949
4950
● message-hookpatterncommand
4951
4952
● mime_lookupmimetype [ mimetype ... ]
4953
4954
● unmime_lookupmimetype [ mimetype ... ]
4955
4956
● monoobject attribute [ regexp ]
4957
4958
● unmonoindexpattern [ pattern ... ]
4959
4960
● my_hdrstring
4961
4962
● unmy_hdrfield [ field ... ]
4963
4964
● crypt-hookpatternkey-id
4965
4966
● pushstring
4967
4968
● resetvariable [variable ... ]
4969
4970
● save-hookregexpfilename
4971
4972
● scorepatternvalue
4973
4974
● unscorepattern [ pattern ... ]
4975
4976
● reply-hookpatterncommand
4977
4978
● send-hookpatterncommand
4979
4980
● send2-hookpatterncommand
4981
4982
● set [no|inv]variable[=value] [ variable ... ]
4983
4984
● unsetvariable [variable ... ]
4985
4986
● sourcefilename
4987
4988
● spampatternformat
4989
4990
● nospampattern
4991
4992
● subscribe [ -groupname [ ... ] ] regexp [ regexp ... ]
4993
4994
● unsubscriberegexp [ regexp ... ]
4995
4996
● togglevariable [variable ... ]
4997
4998
● unhookhook-type
5262
* account-hook pattern command
5263
5264
* alias [ -group name ...] key address [ address ...]
5265
5266
* unalias [ -group name ...] { * | key ... }
5267
5268
* alternates [ -group name ...] regexp [ regexp ...]
5269
5270
* unalternates [ -group name ...] { * | regexp ... }
5271
5272
* alternative-order mimetype [ mimetype ...]
5273
5274
* unalternative-order { * | mimetype ... }
5275
5276
* auto-view mimetype [ mimetype ...]
5277
5278
* unauto-view { * | mimetype ... }
5279
5280
* bind map key function
5281
5282
* charset-hook alias charset
5283
5284
* iconv-hook charset local-charset
5285
5286
* color object foreground background
5287
5288
color { header | body } foreground background regexp
5289
5290
color index foreground background pattern
5291
5292
* uncolor index pattern ...
5293
5294
* exec function [ function ...]
5295
5296
* fcc-hook [!]pattern mailbox
5297
5298
* fcc-save-hook [!]pattern mailbox
5299
5300
* folder-hook [!]regexp command
5301
5302
* group [ -group name ...] { -rx expr ... | -addr expr ... }
5303
5304
* ungroup [ -group name ...] { * | -rx expr ... | -addr expr ... }
5305
5306
* hdr_order header [ header ...]
5307
5308
* unhdr_order { * | header ... }
5309
5310
* ignore pattern [ pattern ...]
5311
5312
* unignore { * | pattern ... }
5313
5314
* lists [ -group name ] regexp [ regexp ...]
5315
5316
* unlists [ -group name ...] { * | regexp ... }
5317
5318
* macro menu key sequence [ description ]
5319
5320
* mailboxes mailbox [ mailbox ...]
5321
5322
* unmailboxes { * | mailbox ... }
5323
5324
* mbox-hook [!]pattern mailbox
5325
5326
* message-hook [!]pattern command
5327
5328
* mime-lookup mimetype [ mimetype ...]
5329
5330
* unmime-lookup { * | mimetype ... }
5331
5332
* mono object attribute
5333
5334
mono { header | body } attribute regexp
5335
5336
mono index attribute pattern
5337
5338
* unmono index { * | pattern ... }
5339
5340
* my_hdr string
5341
5342
* unmy_hdr { * | field ... }
5343
5344
* crypt-hook pattern keyid
5345
5346
* push string
5347
5348
* reset variable [ variable ...]
5349
5350
* save-hook [!]pattern mailbox
5351
5352
* score pattern value
5353
5354
* unscore { * | pattern ... }
5355
5356
* reply-hook [!]pattern command
5357
5358
* send-hook [!]pattern command
5359
5360
* send2-hook [!]pattern command
5361
5362
* set { [ no | inv ] variable | variable=value } [...]
5363
5364
* unset variable [ variable ...]
5365
5366
* source filename
5367
5368
* spam pattern format
5369
5370
* nospam { * | pattern }
5371
5372
* subscribe [ -group name ...] regexp [ regexp ...]
5373
5374
* unsubscribe [ -group name ...] { * | regexp ... }
5375
5376
* toggle variable [ variable ...]
5377
5378
* unhook { * | hook-type }
4999
5379
5000
5380
3. Configuration variables
5001
5381
5020
5400
3.3. alias_file
5021
5401
5022
5402
Type: path
5023
Default: "~/.muttrc"
5403
Default: ??/.muttrc?
5024
5404
5025
The default file in which to save aliases created by the ``create-alias''
5026
function.
5405
The default file in which to save aliases created by the <create-alias>
5406
function. Entries added to this file are encoded in the character set specified
5407
by $config_charset if it is set or the current character set otherwise.
5027
5408
5028
5409
Note: Mutt will not automatically source this file; you must explicitly use the
5029
``source'' command for it to be executed.
5410
?source? command for it to be executed in case this option points to a
5411
dedicated alias file.
5030
5412
5031
The default for this option is the currently used muttrc file, or ``~/.muttrc''
5413
The default for this option is the currently used muttrc file, or ??/.muttrc?
5032
5414
if no user muttrc was found.
5033
5415
5034
5416
3.4. alias_format
5035
5417
5036
5418
Type: string
5037
Default: "%4n %2f %t %-10a %r"
5419
Default: ?%4n %2f %t %-10a %r?
5038
5420
5039
Specifies the format of the data displayed for the `alias' menu. The following
5421
Specifies the format of the data displayed for the ?alias? menu. The following
5040
5422
printf(3)-style sequences are available:
5041
5423
5042
5424
%a
5045
5427
5046
5428
%f
5047
5429
5048
flags - currently, a "d" for an alias marked for deletion
5430
flags - currently, a ?d? for an alias marked for deletion
5049
5431
5050
5432
%n
5051
5433
5076
5458
messages) are to be interpreted. Messages containing these codes are rare, but
5077
5459
if this option is set, their text will be colored accordingly. Note that this
5078
5460
may override your color choices, and even present a security problem, since a
5079
message could include a line like "[-- PGP output follows ..." and give it the
5080
same color as your attachment color.
5461
message could include a line like
5462
5463
[-- PGP output follows ...
5464
5465
5466
and give it the same color as your attachment color (see also $crypt_timestamp
5467
).
5081
5468
5082
5469
3.7. arrow_cursor
5083
5470
5084
5471
Type: boolean
5085
5472
Default: no
5086
5473
5087
When set, an arrow (``->'') will be used to indicate the current entry in menus
5474
When set, an arrow (?->?) will be used to indicate the current entry in menus
5088
5475
instead of highlighting the whole line. On slow network or modem links this
5089
5476
will make response faster because there is less that has to be redrawn on the
5090
5477
screen when moving to the next or previous entries in the menu.
5116
5503
3.11. assumed_charset
5117
5504
5118
5505
Type: string
5119
Default: ""
5506
Default: (empty)
5120
5507
5121
5508
This variable is a colon-separated list of character encoding schemes for
5122
5509
messages without character encoding indication. Header field values and message
5123
5510
body content without character encoding indication would be assumed that they
5124
5511
are written in one of this list. By default, all the header fields and message
5125
body without any charset indication are assumed to be in "us-ascii".
5512
body without any charset indication are assumed to be in ?us-ascii?.
5126
5513
5127
5514
For example, Japanese users might prefer this:
5128
5515
5129
5516
set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
5130
5517
5518
5131
5519
However, only the first content is valid for the message body.
5132
5520
5133
5521
3.12. attach_charset
5134
5522
5135
5523
Type: string
5136
Default: ""
5524
Default: (empty)
5137
5525
5138
5526
This variable is a colon-separated list of character encoding schemes for text
5139
file attachments. If unset, $charset value will be used instead. For example,
5140
the following configuration would work for Japanese text handling:
5527
file attachments. If unset, the value of $charset will be used instead. For
5528
example, the following configuration would work for Japanese text handling:
5141
5529
5142
5530
set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
5143
5531
5144
Note: "iso-2022-*" must be put at the head of the value as shown above if
5145
included.
5532
5533
Note: for Japanese users, ?iso-2022-*? must be put at the head of the value as
5534
shown above if included.
5146
5535
5147
5536
3.13. attach_format
5148
5537
5149
5538
Type: string
5150
Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
5539
Default: ?%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] ?
5151
5540
5152
This variable describes the format of the `attachment' menu. The following
5153
printf-style sequences are understood:
5541
This variable describes the format of the ?attachment? menu. The following
5542
printf(3)-style sequences are understood:
5154
5543
5155
5544
%C
5156
5545
5158
5547
5159
5548
%c
5160
5549
5161
requires charset conversion (n or c)
5550
requires charset conversion (?n? or ?c?)
5162
5551
5163
5552
%D
5164
5553
5178
5567
5179
5568
%I
5180
5569
5181
disposition (I=inline, A=attachment)
5570
disposition (?I? for inline, ?A? for attachment)
5182
5571
5183
5572
%m
5184
5573
5194
5583
5195
5584
%Q
5196
5585
5197
"Q", if MIME part qualifies for attachment counting
5586
?Q?, if MIME part qualifies for attachment counting
5198
5587
5199
5588
%s
5200
5589
5215
5604
%X
5216
5605
5217
5606
number of qualifying MIME parts in this part and its children (please see
5218
the ``attachments'' section for possible speed effects)
5607
the ?attachments? section for possible speed effects)
5219
5608
5220
5609
%>X
5221
5610
5222
right justify the rest of the string and pad with character "X"
5611
right justify the rest of the string and pad with character ?X?
5223
5612
5224
5613
%|X
5225
5614
5226
pad to the end of the line with character "X"
5615
pad to the end of the line with character ?X?
5227
5616
5228
5617
%*X
5229
5618
5230
soft-fill with character "X" as pad
5619
soft-fill with character ?X? as pad
5231
5620
5232
For an explanation of `soft-fill', see the ``$index_format'' documentation.
5621
For an explanation of ?soft-fill?, see the $index_format documentation.
5233
5622
5234
5623
3.14. attach_sep
5235
5624
5236
5625
Type: string
5237
Default: "\n"
5626
Default: ?\n?
5238
5627
5239
5628
The separator to add between attachments when operating (saving, printing,
5240
5629
piping, etc) on a list of tagged attachments.
5246
5635
5247
5636
If this variable is unset, when operating (saving, printing, piping, etc) on a
5248
5637
list of tagged attachments, Mutt will concatenate the attachments and will
5249
operate on them as a single attachment. The ``$attach_sep'' separator is added
5638
operate on them as a single attachment. The $attach_sep separator is added
5250
5639
after each attachment. When set, Mutt will operate on the attachments one by
5251
5640
one.
5252
5641
5253
5642
3.16. attribution
5254
5643
5255
5644
Type: string
5256
Default: "On %d, %n wrote:"
5645
Default: ?On %d, %n wrote:?
5257
5646
5258
5647
This is the string that will precede a message which has been included in a
5259
reply. For a full listing of defined printf()-like sequences see the section on
5260
``$index_format''.
5648
reply. For a full listing of defined printf(3)-like sequences see the section
5649
on $index_format.
5261
5650
5262
5651
3.17. autoedit
5263
5652
5264
5653
Type: boolean
5265
5654
Default: no
5266
5655
5267
When set along with ``$edit_headers'', Mutt will skip the initial send-menu and
5268
allow you to immediately begin editing the body of your message. The send-menu
5269
may still be accessed once you have finished editing the body of your message.
5656
When set along with $edit_headers, Mutt will skip the initial send-menu
5657
(prompting for subject and recipients) and allow you to immediately begin
5658
editing the body of your message. The send-menu may still be accessed once you
5659
have finished editing the body of your message.
5270
5660
5271
Also see ``$fast_reply''.
5661
Also see $fast_reply.
5272
5662
5273
5663
3.18. auto_tag
5274
5664
5277
5667
5278
5668
When set, functions in the index menu which affect a message will be applied to
5279
5669
all tagged messages (if there are any). When unset, you must first use the
5280
tag-prefix function (default: ";") to make the next function apply to all
5281
tagged messages.
5670
<tag-prefix> function (bound to ?;? by default) to make the next function apply
5671
to all tagged messages.
5282
5672
5283
5673
3.19. beep
5284
5674
5293
5683
Default: no
5294
5684
5295
5685
When this variable is set, mutt will beep whenever it prints a message
5296
notifying you of new mail. This is independent of the setting of the ``$beep''
5686
notifying you of new mail. This is independent of the setting of the $beep
5297
5687
variable.
5298
5688
5299
5689
3.21. bounce
5320
5710
Default: no
5321
5711
5322
5712
When this variable is set, mutt will place the cursor at the beginning of the
5323
current line in menus, even when the arrow_cursor variable is unset, making it
5713
current line in menus, even when the $arrow_cursor variable is unset, making it
5324
5714
easier for blind persons using Braille displays to follow these menus. The
5325
option is disabled by default because many visual terminals don't permit making
5715
option is unset by default because many visual terminals don't permit making
5326
5716
the cursor invisible.
5327
5717
5328
5718
3.24. check_mbox_size
5331
5721
Default: no
5332
5722
5333
5723
When this variable is set, mutt will use file size attribute instead of access
5334
time when checking for new mail.
5724
time when checking for new mail in mbox and mmdf folders.
5725
5726
This variable is unset by default and should only be enabled when new mail
5727
detection for these folder types is unreliable or doesn't work.
5728
5729
Note that enabling this variable should happen before any ?mailboxes?
5730
directives occur in configuration files regarding mbox or mmdf folders because
5731
mutt needs to determine the initial new mail status of such a mailbox by
5732
performing a fast mailbox scan when it is defined. Afterwards the new mail
5733
status is tracked by file size changes.
5335
5734
5336
5735
3.25. charset
5337
5736
5338
5737
Type: string
5339
Default: ""
5738
Default: (empty)
5340
5739
5341
5740
Character set your terminal uses to display and enter textual data. It is also
5342
5741
the fallback for $send_charset.
5343
5742
5743
Upon startup Mutt tries to derive this value from environment variables such as
5744
$LC_CTYPE or $LANG.
5745
5746
Note: It should only be set in case Mutt isn't abled to determine the character
5747
set used correctly.
5748
5344
5749
3.26. check_new
5345
5750
5346
5751
Type: boolean
5351
5756
When set, Mutt will check for new mail delivered while the mailbox is open.
5352
5757
Especially with MH mailboxes, this operation can take quite some time since it
5353
5758
involves scanning the directory and checking each file to see if it has already
5354
been looked at. If check_new is unset, no check for new mail is performed while
5355
the mailbox is open.
5759
been looked at. If this variable is unset, no check for new mail is performed
5760
while the mailbox is open.
5356
5761
5357
5762
3.27. collapse_unread
5358
5763
5372
5777
3.29. compose_format
5373
5778
5374
5779
Type: string
5375
Default: "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-"
5780
Default: ?-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-?
5376
5781
5377
Controls the format of the status line displayed in the Compose menu. This
5378
string is similar to ``$status_format'', but has its own set of printf()-like
5782
Controls the format of the status line displayed in the ?compose? menu. This
5783
string is similar to $status_format, but has its own set of printf(3)-like
5379
5784
sequences:
5380
5785
5381
5786
%a
5394
5799
5395
5800
Mutt version string
5396
5801
5397
See the text describing the ``$status_format'' option for more information on
5398
how to set ``$compose_format''.
5802
See the text describing the $status_format option for more information on how
5803
to set $compose_format.
5399
5804
5400
5805
3.30. config_charset
5401
5806
5402
5807
Type: string
5403
Default: ""
5404
5405
When defined, Mutt will recode commands in rc files from this encoding.
5808
Default: (empty)
5809
5810
When defined, Mutt will recode commands in rc files from this encoding to the
5811
current character set as specified by $charset and aliases written to
5812
$alias_file from the current character set.
5813
5814
Please note that if setting $charset it must be done before setting
5815
$config_charset.
5816
5817
Recoding should be avoided as it may render unconvertable characters as
5818
question marks which can lead to undesired side effects (for example in regular
5819
expressions).
5406
5820
5407
5821
3.31. confirmappend
5408
5822
5425
5839
Type: number
5426
5840
Default: 30
5427
5841
5428
Causes Mutt to timeout a network connection (for IMAP or POP) after this many
5429
seconds if the connection is not able to be established. A negative value
5430
causes Mutt to wait indefinitely for the connection to succeed.
5842
Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
5843
many seconds if the connection is not able to be established. A negative value
5844
causes Mutt to wait indefinitely for the connection attempt to succeed.
5431
5845
5432
5846
3.34. content_type
5433
5847
5434
5848
Type: string
5435
Default: "text/plain"
5849
Default: ?text/plain?
5436
5850
5437
5851
Sets the default Content-Type for the body of newly composed messages.
5438
5852
5442
5856
Default: yes
5443
5857
5444
5858
This variable controls whether or not copies of your outgoing messages will be
5445
saved for later references. Also see ``$record'', ``$save_name'', ``$force_name
5446
'' and ``fcc-hook''.
5859
saved for later references. Also see $record, $save_name, $force_name and ?
5860
fcc-hook?.
5447
5861
5448
5862
3.36. crypt_use_gpgme
5449
5863
5460
5874
Type: boolean
5461
5875
Default: no
5462
5876
5463
(http://www.g10code.de/docs/pka-intro.de.pdf) during signature verification
5464
(only supported by the GPGME backend).
5877
Controls whether mutt uses PKA (see http://www.g10code.de/docs/
5878
pka-intro.de.pdf) during signature verification (only supported by the GPGME
5879
backend).
5465
5880
5466
5881
3.38. crypt_autopgp
5467
5882
5469
5884
Default: yes
5470
5885
5471
5886
This variable controls whether or not mutt may automatically enable PGP
5472
encryption/signing for messages. See also ``$crypt_autoencrypt'', ``
5473
$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``
5474
$smime_is_default''.
5887
encryption/signing for messages. See also $crypt_autoencrypt,
5888
$crypt_replyencrypt, $crypt_autosign, $crypt_replysign and $smime_is_default.
5475
5889
5476
5890
3.39. crypt_autosmime
5477
5891
5479
5893
Default: yes
5480
5894
5481
5895
This variable controls whether or not mutt may automatically enable S/MIME
5482
encryption/signing for messages. See also ``$crypt_autoencrypt'', ``
5483
$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``
5484
$smime_is_default''.
5896
encryption/signing for messages. See also $crypt_autoencrypt,
5897
$crypt_replyencrypt, $crypt_autosign, $crypt_replysign and $smime_is_default.
5485
5898
5486
5899
3.40. date_format
5487
5900
5488
5901
Type: string
5489
Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"
5490
5491
This variable controls the format of the date printed by the ``%d'' sequence in
5492
``$index_format''. This is passed to the strftime call to process the date. See
5493
the man page for strftime(3) for the proper syntax.
5494
5495
Unless the first character in the string is a bang (``!''), the month and week
5496
day names are expanded according to the locale specified in the variable ``
5497
$locale''. If the first character in the string is a bang, the bang is
5498
discarded, and the month and week day names in the rest of the string are
5499
expanded in the C locale (that is in US English).
5902
Default: ?!%a, %b %d, %Y at %I:%M:%S%p %Z?
5903
5904
This variable controls the format of the date printed by the ?%d? sequence in
5905
$index_format. This is passed to the strftime(3) function to process the date,
5906
see the man page for the proper syntax.
5907
5908
Unless the first character in the string is a bang (?!?), the month and week
5909
day names are expanded according to the locale specified in the variable
5910
$locale. If the first character in the string is a bang, the bang is discarded,
5911
and the month and week day names in the rest of the string are expanded in the
5912
C locale (that is in US English).
5500
5913
5501
5914
3.41. default_hook
5502
5915
5503
5916
Type: string
5504
Default: "~f %s !~P | (~P ~C %s)"
5505
5506
This variable controls how message-hooks, reply-hooks, send-hooks, send2-hooks,
5507
save-hooks, and fcc-hooks will be interpreted if they are specified with only a
5508
simple regexp, instead of a matching pattern. The hooks are expanded when they
5509
are declared, so a hook will be interpreted according to the value of this
5510
variable at the time the hook is declared. The default value matches if the
5511
message is either from a user matching the regular expression given, or if it
5512
is from you (if the from address matches ``alternates'') and is to or cc'ed to
5513
a user matching the given regular expression.
5917
Default: ??f %s !?P | (?P ?C %s)?
5918
5919
This variable controls how ?message-hook?, ?reply-hook?, ?send-hook?, ?
5920
send2-hook?, ?save-hook?, and ?fcc-hook? will be interpreted if they are
5921
specified with only a simple regexp, instead of a matching pattern. The hooks
5922
are expanded when they are declared, so a hook will be interpreted according to
5923
the value of this variable at the time the hook is declared.
5924
5925
The default value matches if the message is either from a user matching the
5926
regular expression given, or if it is from you (if the from address matches ?
5927
alternates?) and is to or cc'ed to a user matching the given regular
5928
expression.
5514
5929
5515
5930
3.42. delete
5516
5931
5538
5953
5539
5954
If this option is set, mutt's received-attachments menu will not show the
5540
5955
subparts of individual messages in a multipart/digest. To see these subparts,
5541
press 'v' on that menu.
5956
press ?v? on that menu.
5542
5957
5543
5958
3.45. display_filter
5544
5959
5545
5960
Type: path
5546
Default: ""
5961
Default: (empty)
5547
5962
5548
5963
When set, specifies a command used to filter messages. When a message is viewed
5549
5964
it is passed as standard input to $display_filter, and the filtered message is
5552
5967
3.46. dotlock_program
5553
5968
5554
5969
Type: path
5555
Default: "/usr/local/bin/mutt_dotlock"
5970
Default: ?/usr/local/bin/mutt_dotlock?
5556
5971
5557
Contains the path of the mutt_dotlock (8) binary to be used by mutt.
5972
Contains the path of the mutt_dotlock(8) binary to be used by mutt.
5558
5973
5559
5974
3.47. dsn_notify
5560
5975
5561
5976
Type: string
5562
Default: ""
5977
Default: (empty)
5563
5978
5564
5979
This variable sets the request for when notification is returned. The string
5565
5980
consists of a comma separated list (no spaces!) of one or more of the
5567
5982
notification on transmission failure, delay, to be notified of message delays,
5568
5983
success, to be notified of successful transmission.
5569
5984
5570
Example: set dsn_notify="failure,delay"
5985
Example:
5986
5987
set dsn_notify="failure,delay"
5988
5571
5989
5572
5990
Note: when using $sendmail for delivery, you should not enable this unless you
5573
5991
are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
5574
-compatible interface supporting the -N option for DSN. For SMTP delivery, it
5575
depends on the server whether DSN is supported or not.
5992
-compatible interface supporting the -N option for DSN. For SMTP delivery, DSN
5993
support is autodetected so that it depends on the server whether DSN will be
5994
used or not.
5576
5995
5577
5996
3.48. dsn_return
5578
5997
5579
5998
Type: string
5580
Default: ""
5999
Default: (empty)
5581
6000
5582
6001
This variable controls how much of your message is returned in DSN messages. It
5583
6002
may be set to either hdrs to return just the message header, or full to return
5584
6003
the full message.
5585
6004
5586
Example: set dsn_return=hdrs
6005
Example:
6006
6007
set dsn_return=hdrs
6008
5587
6009
5588
6010
Note: when using $sendmail for delivery, you should not enable this unless you
5589
6011
are either using Sendmail 8.8.x or greater or a MTA providing a sendmail(1)
5590
-compatible interface supporting the -R option for DSN. For SMTP delivery, it
5591
depends on the server whether DSN is supported or not.
6012
-compatible interface supporting the -R option for DSN. For SMTP delivery, DSN
6013
support is autodetected so that it depends on the server whether DSN will be
6014
used or not.
5592
6015
5593
6016
3.49. duplicate_threads
5594
6017
5595
6018
Type: boolean
5596
6019
Default: yes
5597
6020
5598
This variable controls whether mutt, when sorting by threads, threads messages
5599
with the same message-id together. If it is set, it will indicate that it
5600
thinks they are duplicates of each other with an equals sign in the thread
5601
diagram.
6021
This variable controls whether mutt, when $sort is set to threads, threads
6022
messages with the same Message-Id together. If it is set, it will indicate that
6023
it thinks they are duplicates of each other with an equals sign in the thread
6024
tree.
5602
6025
5603
6026
3.50. edit_headers
5604
6027
5614
6037
3.51. editor
5615
6038
5616
6039
Type: path
5617
Default: ""
6040
Default: (empty)
5618
6041
5619
6042
This variable specifies which editor is used by mutt. It defaults to the value
5620
of the VISUAL, or EDITOR, environment variable, or to the string "vi" if
6043
of the $VISUAL, or $EDITOR, environment variable, or to the string ?vi? if
5621
6044
neither of those are set.
5622
6045
5623
6046
3.52. encode_from
5626
6049
Default: no
5627
6050
5628
6051
When set, mutt will quoted-printable encode messages when they contain the
5629
string "From " in the beginning of a line. Useful to avoid the tampering
5630
certain mail delivery and transport agents tend to do with messages.
6052
string ?From ? (note the trailing space) in the beginning of a line. This is
6053
useful to avoid the tampering certain mail delivery and transport agents tend
6054
to do with messages (in order to prevent tools from misinterpreting the line as
6055
a mbox message separator).
5631
6056
5632
6057
3.53. envelope_from_address
5633
6058
5634
6059
Type: e-mail address
5635
Default: ""
6060
Default: (empty)
5636
6061
5637
6062
Manually sets the envelope sender for outgoing messages. This value is ignored
5638
if ``$use_envelope_from'' is unset.
6063
if $use_envelope_from is unset.
5639
6064
5640
6065
3.54. escape
5641
6066
5642
6067
Type: string
5643
Default: "~"
6068
Default: ???
5644
6069
5645
6070
Escape character to use for functions in the builtin editor.
5646
6071
5653
6078
replying to messages, and the initial prompt for subject is skipped when
5654
6079
forwarding messages.
5655
6080
5656
Note: this variable has no effect when the ``$autoedit'' variable is set.
6081
Note: this variable has no effect when the $autoedit variable is set.
5657
6082
5658
6083
3.56. fcc_attach
5659
6084
5674
6099
3.58. folder
5675
6100
5676
6101
Type: path
5677
Default: "~/Mail"
6102
Default: ??/Mail?
5678
6103
5679
Specifies the default location of your mailboxes. A `+' or `=' at the beginning
6104
Specifies the default location of your mailboxes. A ?+? or ?=? at the beginning
5680
6105
of a pathname will be expanded to the value of this variable. Note that if you
5681
change this variable from the default value you need to make sure that the
5682
assignment occurs before you use `+' or `=' for any other variables since
5683
expansion takes place during the `set' command.
6106
change this variable (from the default) value you need to make sure that the
6107
assignment occurs before you use ?+? or ?=? for any other variables since
6108
expansion takes place when handling the ?mailboxes? command.
5684
6109
5685
6110
3.59. folder_format
5686
6111
5687
6112
Type: string
5688
Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"
6113
Default: ?%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f?
5689
6114
5690
6115
This variable allows you to customize the file browser display to your personal
5691
taste. This string is similar to ``$index_format'', but has its own set of
5692
printf()-like sequences:
6116
taste. This string is similar to $index_format, but has its own set of printf
6117
(3)-like sequences:
5693
6118
5694
6119
%C
5695
6120
5725
6150
5726
6151
%t
5727
6152
5728
* if the file is tagged, blank otherwise
6153
?*? if the file is tagged, blank otherwise
5729
6154
5730
6155
%u
5731
6156
5733
6158
5734
6159
%>X
5735
6160
5736
right justify the rest of the string and pad with character "X"
6161
right justify the rest of the string and pad with character ?X?
5737
6162
5738
6163
%|X
5739
6164
5740
pad to the end of the line with character "X"
6165
pad to the end of the line with character ?X?
5741
6166
5742
6167
%*X
5743
6168
5744
soft-fill with character "X" as pad
6169
soft-fill with character ?X? as pad
5745
6170
5746
For an explanation of `soft-fill', see the ``$index_format'' documentation.
6171
For an explanation of ?soft-fill?, see the $index_format documentation.
5747
6172
5748
6173
3.60. followup_to
5749
6174
5750
6175
Type: boolean
5751
6176
Default: yes
5752
6177
5753
Controls whether or not the Mail-Followup-To header field is generated when
6178
Controls whether or not the ?Mail-Followup-To:? header field is generated when
5754
6179
sending mail. When set, Mutt will generate this field when you are replying to
5755
a known mailing list, specified with the ``subscribe'' or ``lists'' commands.
6180
a known mailing list, specified with the ?subscribe? or ?lists? commands.
5756
6181
5757
6182
This field has two purposes. First, preventing you from receiving duplicate
5758
6183
copies of replies to messages which you send to mailing lists, and second,
5759
6184
ensuring that you do get a reply separately for any messages sent to known
5760
lists to which you are not subscribed. The header will contain only the list's
5761
address for subscribed lists, and both the list address and your own email
5762
address for unsubscribed lists. Without this header, a group reply to your
5763
message sent to a subscribed list will be sent to both the list and your
5764
address, resulting in two copies of the same email for you.
6185
lists to which you are not subscribed.
6186
6187
The header will contain only the list's address for subscribed lists, and both
6188
the list address and your own email address for unsubscribed lists. Without
6189
this header, a group reply to your message sent to a subscribed list will be
6190
sent to both the list and your address, resulting in two copies of the same
6191
email for you.
5765
6192
5766
6193
3.61. force_name
5767
6194
5768
6195
Type: boolean
5769
6196
Default: no
5770
6197
5771
This variable is similar to ``$save_name'', except that Mutt will store a copy
5772
of your outgoing message by the username of the address you are sending to even
5773
if that mailbox does not exist.
6198
This variable is similar to $save_name, except that Mutt will store a copy of
6199
your outgoing message by the username of the address you are sending to even if
6200
that mailbox does not exist.
5774
6201
5775
Also see the ``$record'' variable.
6202
Also see the $record variable.
5776
6203
5777
6204
3.62. forward_decode
5778
6205
5781
6208
5782
6209
Controls the decoding of complex MIME messages into text/plain when forwarding
5783
6210
a message. The message header is also RFC2047 decoded. This variable is only
5784
used, if ``$mime_forward'' is unset, otherwise ``$mime_forward_decode'' is used
6211
used, if $mime_forward is unset, otherwise $mime_forward_decode is used
5785
6212
instead.
5786
6213
5787
6214
3.63. forward_edit
5791
6218
5792
6219
This quadoption controls whether or not the user is automatically placed in the
5793
6220
editor when forwarding messages. For those who always want to forward with no
5794
modification, use a setting of ``no''.
6221
modification, use a setting of ?no?.
5795
6222
5796
6223
3.64. forward_format
5797
6224
5798
6225
Type: string
5799
Default: "[%a: %s]"
6226
Default: ?[%a: %s]?
5800
6227
5801
6228
This variable controls the default subject when forwarding a message. It uses
5802
the same format sequences as the ``$index_format'' variable.
6229
the same format sequences as the $index_format variable.
5803
6230
5804
6231
3.65. forward_quote
5805
6232
5806
6233
Type: boolean
5807
6234
Default: no
5808
6235
5809
When set forwarded messages included in the main body of the message (when ``
5810
$mime_forward'' is unset) will be quoted using ``$indent_string''.
6236
When set, forwarded messages included in the main body of the message (when
6237
$mime_forward is unset) will be quoted using $indent_string.
5811
6238
5812
6239
3.66. from
5813
6240
5814
6241
Type: e-mail address
5815
Default: ""
6242
Default: (empty)
5816
6243
5817
6244
When set, this variable contains a default from address. It can be overridden
5818
using my_hdr (including from send-hooks) and ``$reverse_name''. This variable
5819
is ignored if ``$use_from'' is unset.
6245
using ?my_hdr? (including from a ?send-hook?) and $reverse_name. This variable
6246
is ignored if $use_from is unset.
5820
6247
5821
Defaults to the contents of the environment variable EMAIL.
6248
This setting defaults to the contents of the environment variable $EMAIL.
5822
6249
5823
6250
3.67. gecos_mask
5824
6251
5825
6252
Type: regular expression
5826
Default: "^[^,]*"
6253
Default: ?^[^,]*?
5827
6254
5828
6255
A regular expression used by mutt to parse the GECOS field of a password entry
5829
when expanding the alias. By default the regular expression is set to "^[^,]*"
5830
which will return the string up to the first "," encountered. If the GECOS
5831
field contains a string like "lastname, firstname" then you should set the
5832
gecos_mask=".*".
6256
when expanding the alias. The default value will return the string up to the
6257
first ?,? encountered. If the GECOS field contains a string like ?lastname,
6258
firstname? then you should set it to ?.*?.
5833
6259
5834
6260
This can be useful if you see the following behavior: you address a e-mail to
5835
user ID stevef whose full name is Steve Franklin. If mutt expands stevef to
5836
"Franklin" stevef@foo.bar then you should set the gecos_mask to a regular
5837
expression that will match the whole name so mutt will expand "Franklin" to
5838
"Franklin, Steve".
6261
user ID ?stevef? whose full name is ?Steve Franklin?. If mutt expands ?stevef?
6262
to ?"Franklin" stevef@foo.bar? then you should set the $gecos_mask to a regular
6263
expression that will match the whole name so mutt will expand ?Franklin? to
6264
?Franklin, Steve?.
5839
6265
5840
6266
3.68. hdrs
5841
6267
5842
6268
Type: boolean
5843
6269
Default: yes
5844
6270
5845
When unset, the header fields normally added by the ``my_hdr'' command are not
6271
When unset, the header fields normally added by the ?my_hdr? command are not
5846
6272
created. This variable must be unset before composing a new message or replying
5847
6273
in order to take effect. If set, the user defined header fields are added to
5848
6274
every new message.
5853
6279
Default: no
5854
6280
5855
6281
When set, this variable causes Mutt to include the header of the message you
5856
are replying to into the edit buffer. The ``$weed'' setting applies.
6282
are replying to into the edit buffer. The $weed setting applies.
5857
6283
5858
6284
3.70. help
5859
6285
5873
6299
Type: boolean
5874
6300
Default: no
5875
6301
5876
When set, mutt will skip the host name part of ``$hostname'' variable when
5877
adding the domain part to addresses. This variable does not affect the
5878
generation of Message-IDs, and it will not lead to the cut-off of first-level
5879
domains.
6302
When set, mutt will skip the host name part of $hostname variable when adding
6303
the domain part to addresses. This variable does not affect the generation of
6304
Message-IDs, and it will not lead to the cut-off of first-level domains.
5880
6305
5881
6306
3.72. hide_limited
5882
6307
5926
6351
Default: 10
5927
6352
5928
6353
This variable controls the size (in number of strings remembered) of the string
5929
history buffer. The buffer is cleared each time the variable is set.
6354
history buffer per category. The buffer is cleared each time the variable is
6355
set.
5930
6356
5931
6357
3.78. history_file
5932
6358
5933
6359
Type: path
5934
Default: "~/.mutthistory"
6360
Default: ??/.mutthistory?
5935
6361
5936
6362
The file in which Mutt will save its history.
5937
6363
5946
6372
3.80. hostname
5947
6373
5948
6374
Type: string
5949
Default: ""
6375
Default: (empty)
5950
6376
5951
6377
Specifies the fully-qualified hostname of the system mutt is running on
5952
6378
containing the host's name and the DNS domain it belongs to. It is used as the
5953
domain part (after ``@'') for local email addresses as well as Message-Id
6379
domain part (after ?@?) for local email addresses as well as Message-Id
5954
6380
headers.
5955
6381
5956
6382
Its value is determined at startup as follows: If the node's name as returned
5957
6383
by the uname(3) function contains the hostname and the domain, these are used
5958
6384
to construct $hostname. If there is no domain part returned, Mutt will look for
5959
a ``domain'' or ``search'' line in /etc/resolv.conf to determine the domain.
6385
a ?domain? or ?search? line in /etc/resolv.conf to determine the domain.
5960
6386
Optionally, Mutt can be compiled with a fixed domain name in which case a
5961
6387
detected one is not used.
5962
6388
5963
Also see ``$use_domain'' and ``$hidden_host''.
6389
Also see $use_domain and $hidden_host.
5964
6390
5965
6391
3.81. ignore_linear_white_space
5966
6392
5967
6393
Type: boolean
5968
6394
Default: no
5969
6395
5970
This option replaces linear-white-space between encoded-word and *text to a
5971
single space to prevent the display of MIME-encoded ``Subject'' field from
5972
being divided into multiple lines.
6396
This option replaces linear-white-space between encoded-word and text to a
6397
single space to prevent the display of MIME-encoded ?Subject:? field from being
6398
divided into multiple lines.
5973
6399
5974
6400
3.82. ignore_list_reply_to
5975
6401
5976
6402
Type: boolean
5977
6403
Default: no
5978
6404
5979
Affects the behaviour of the reply function when replying to messages from
5980
mailing lists (as defined by the ``subscribe'' or ``lists'' commands). When
5981
set, if the ``Reply-To:'' field is set to the same value as the ``To:'' field,
5982
Mutt assumes that the ``Reply-To:'' field was set by the mailing list to
5983
automate responses to the list, and will ignore this field. To direct a
5984
response to the mailing list when this option is set, use the list-reply
5985
function; group-reply will reply to both the sender and the list.
6405
Affects the behaviour of the <reply> function when replying to messages from
6406
mailing lists (as defined by the ?subscribe? or ?lists? commands). When set, if
6407
the ?Reply-To:? field is set to the same value as the ?To:? field, Mutt assumes
6408
that the ?Reply-To:? field was set by the mailing list to automate responses to
6409
the list, and will ignore this field. To direct a response to the mailing list
6410
when this option is set, use the <list-reply> function; <group-reply> will
6411
reply to both the sender and the list.
5986
6412
5987
6413
3.83. imap_authenticators
5988
6414
5989
6415
Type: string
5990
Default: ""
6416
Default: (empty)
5991
6417
5992
6418
This is a colon-delimited list of authentication methods mutt may attempt to
5993
6419
use to log in to an IMAP server, in the order mutt should try them.
5994
Authentication methods are either 'login' or the right side of an IMAP 'AUTH=
5995
xxx' capability string, eg 'digest-md5', 'gssapi' or 'cram-md5'. This parameter
5996
is case-insensitive. If this parameter is unset (the default) mutt will try all
5997
available methods, in order from most-secure to least-secure.
5998
5999
Example: set imap_authenticators="gssapi:cram-md5:login"
6420
Authentication methods are either ?login? or the right side of an IMAP ?AUTH=
6421
xxx? capability string, eg ?digest-md5?, ?gssapi? or ?cram-md5?. This option is
6422
case-insensitive. If it's unset (the default) mutt will try all available
6423
methods, in order from most-secure to least-secure.
6424
6425
Example:
6426
6427
set imap_authenticators="gssapi:cram-md5:login"
6428
6000
6429
6001
6430
Note: Mutt will only fall back to other authentication methods if the previous
6002
6431
methods are unavailable. If a method is available but authentication fails,
6008
6437
Default: no
6009
6438
6010
6439
When set, mutt will fetch the set of subscribed folders from your server on
6011
connection, and add them to the set of mailboxes it polls for new mail. See
6012
also the ``mailboxes'' command.
6440
connection, and add them to the set of mailboxes it polls for new mail just as
6441
if you had issued individual ?mailboxes? commands.
6013
6442
6014
6443
3.85. imap_delim_chars
6015
6444
6016
6445
Type: string
6017
Default: "/."
6446
Default: ?/.?
6018
6447
6019
6448
This contains the list of characters which you would like to treat as folder
6020
separators for displaying IMAP paths. In particular it helps in using the '='
6449
separators for displaying IMAP paths. In particular it helps in using the ?=?
6021
6450
shortcut for your folder variable.
6022
6451
6023
6452
3.86. imap_headers
6024
6453
6025
6454
Type: string
6026
Default: ""
6027
6028
Mutt requests these header fields in addition to the default headers ("DATE
6029
FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE CONTENT-DESCRIPTION
6030
IN-REPLY-TO REPLY-TO LINES X-LABEL") from IMAP servers before displaying the
6031
index menu. You may want to add more headers for spam detection. Note: This is
6032
a space separated list.
6455
Default: (empty)
6456
6457
Mutt requests these header fields in addition to the default headers (?Date:?,
6458
?From:?, ?Subject:?, ?To:?, ?Cc:?, ?Message-Id:?, ?References:?,
6459
?Content-Type:?, ?Content-Description:?, ?In-Reply-To:?, ?Reply-To:?, ?Lines:?,
6460
?List-Post:?, ?X-Label:?) from IMAP servers before displaying the index menu.
6461
You may want to add more headers for spam detection.
6462
6463
Note: This is a space separated list, items should be uppercase and not contain
6464
the colon, e.g. ?X-BOGOSITY X-SPAM-STATUS? for the ?X-Bogosity:? and
6465
?X-Spam-Status:? header fields.
6033
6466
6034
6467
3.87. imap_idle
6035
6468
6061
6494
6062
6495
This variable configures whether IMAP folder browsing will look for only
6063
6496
subscribed folders or all folders. This can be toggled in the IMAP browser with
6064
the toggle-subscribed function.
6497
the <toggle-subscribed> function.
6065
6498
6066
6499
3.90. imap_login
6067
6500
6068
6501
Type: string
6069
Default: ""
6502
Default: (empty)
6070
6503
6071
6504
Your login name on the IMAP server.
6072
6505
6073
This variable defaults to the value of imap_user.
6506
This variable defaults to the value of $imap_user.
6074
6507
6075
6508
3.91. imap_pass
6076
6509
6077
6510
Type: string
6078
Default: ""
6511
Default: (empty)
6079
6512
6080
6513
Specifies the password for your IMAP account. If unset, Mutt will prompt you
6081
for your password when you invoke the fetch-mail function. Warning: you should
6082
only use this option when you are on a fairly secure machine, because the
6083
superuser can read your muttrc even if you are the only one who can read the
6084
file.
6514
for your password when you invoke the <fetch-mail> function or try to open an
6515
IMAP folder.
6516
6517
Warning: you should only use this option when you are on a fairly secure
6518
machine, because the superuser can read your muttrc even if you are the only
6519
one who can read the file.
6085
6520
6086
6521
3.92. imap_passive
6087
6522
6103
6538
closing an IMAP folder somewhat slower. This option exists to appease speed
6104
6539
freaks.
6105
6540
6106
3.94. imap_servernoise
6541
3.94. imap_pipeline_depth
6542
6543
Type: number
6544
Default: 15
6545
6546
Controls the number of IMAP commands that may be queued up before they are sent
6547
to the server. A deeper pipeline reduces the amount of time mutt must wait for
6548
the server, and can make IMAP servers feel much more responsive. But not all
6549
servers correctly handle pipelined commands, so if you have problems you might
6550
want to try setting this variable to 0.
6551
6552
Note: Changes to this variable have no effect on open connections.
6553
6554
3.95. imap_servernoise
6107
6555
6108
6556
Type: boolean
6109
6557
Default: yes
6113
6561
configuration problems on the server which are out of the users' hands, you may
6114
6562
wish to suppress them at some point.
6115
6563
6116
3.95. imap_user
6564
3.96. imap_user
6117
6565
6118
6566
Type: string
6119
Default: ""
6567
Default: (empty)
6120
6568
6121
6569
The name of the user whose mail you intend to access on the IMAP server.
6122
6570
6123
6571
This variable defaults to your user name on the local machine.
6124
6572
6125
3.96. implicit_autoview
6573
3.97. implicit_autoview
6126
6574
6127
6575
Type: boolean
6128
6576
Default: no
6129
6577
6130
If set to ``yes'', mutt will look for a mailcap entry with the copiousoutput
6578
If set to ?yes?, mutt will look for a mailcap entry with the ?copiousoutput?
6131
6579
flag set for every MIME attachment it doesn't have an internal viewer defined
6132
6580
for. If such an entry is found, mutt will use the viewer defined in that entry
6133
6581
to convert the body part to text form.
6134
6582
6135
3.97. include
6583
3.98. include
6136
6584
6137
6585
Type: quadoption
6138
6586
Default: ask-yes
6140
6588
Controls whether or not a copy of the message(s) you are replying to is
6141
6589
included in your reply.
6142
6590
6143
3.98. include_onlyfirst
6591
3.99. include_onlyfirst
6144
6592
6145
6593
Type: boolean
6146
6594
Default: no
6148
6596
Controls whether or not Mutt includes only the first attachment of the message
6149
6597
you are replying.
6150
6598
6151
3.99. indent_string
6599
3.100. indent_string
6152
6600
6153
6601
Type: string
6154
Default: "> "
6602
Default: ?> ?
6155
6603
6156
6604
Specifies the string to prepend to each line of text quoted in a message to
6157
6605
which you are replying. You are strongly encouraged not to change this value,
6158
6606
as it tends to agitate the more fanatical netizens.
6159
6607
6160
This option is a format string, please see the description of ``$index_format''
6161
for supported printf()-style sequences.
6162
6163
3.100. index_format
6608
This option is a format string, please see the description of $index_format for
6609
supported printf(3)-style sequences.
6610
6611
Because for format=lowed style messages the quoting mechanism is strictly
6612
defined, this setting is ignored if $text_flowed is set.
6613
6614
3.101. index_format
6164
6615
6165
6616
Type: string
6166
Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
6617
Default: ?%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s?
6167
6618
6168
6619
This variable allows you to customize the message index display to your
6169
6620
personal taste.
6170
6621
6171
``Format strings'' are similar to the strings used in the ``C'' function printf
6172
to format output (see the man page for more detail). The following sequences
6173
are defined in Mutt:
6622
?Format strings? are similar to the strings used in the C function printf(3) to
6623
format output (see the man page for more details). The following sequences are
6624
defined in Mutt:
6174
6625
6175
6626
%a
6176
6627
6182
6633
6183
6634
%b
6184
6635
6185
filename of the original message folder (think mailBox)
6636
filename of the original message folder (think mailbox)
6186
6637
6187
6638
%B
6188
6639
6198
6649
6199
6650
%d
6200
6651
6201
date and time of the message in the format specified by ``date_format''
6652
date and time of the message in the format specified by $date_format
6202
6653
converted to sender's time zone
6203
6654
6204
6655
%D
6205
6656
6206
date and time of the message in the format specified by ``date_format''
6657
date and time of the message in the format specified by $date_format
6207
6658
converted to the local time zone
6208
6659
6209
6660
%e
6237
6688
6238
6689
%L
6239
6690
6240
If an address in the To or CC header field matches an address defined by
6241
the users ``subscribe'' command, this displays "To <list-name>", otherwise
6691
If an address in the ?To:? or ?Cc:? header field matches an address defined
6692
by the users ?subscribe? command, this displays "To <list-name>", otherwise
6242
6693
the same as %F.
6243
6694
6244
6695
%m
6259
6710
6260
6711
%O
6261
6712
6262
(_O_riginal save folder) Where mutt would formerly have stashed the
6263
message: list name or recipient name if no list
6713
original save folder where mutt would formerly have stashed the message:
6714
list name or recipient name if not sent to a list
6264
6715
6265
6716
%P
6266
6717
6273
6724
6274
6725
%S
6275
6726
6276
status of the message (N/D/d/!/r/*)
6727
status of the message (?N?/?D?/?d?/?!?/?r?/*)
6277
6728
6278
6729
%t
6279
6730
6280
`to:' field (recipients)
6731
?To:? field (recipients)
6281
6732
6282
6733
%T
6283
6734
6293
6744
6294
6745
%X
6295
6746
6296
number of attachments (please see the ``attachments'' section for possible
6747
number of attachments (please see the ?attachments? section for possible
6297
6748
speed effects)
6298
6749
6299
6750
%y
6300
6751
6301
`x-label:' field, if present
6752
?X-Label:? field, if present
6302
6753
6303
6754
%Y
6304
6755
6305
`x-label' field, if present, and (1) not at part of a thread tree, (2) at
6306
the top of a thread, or (3) `x-label' is different from preceding message's
6307
`x-label'.
6756
?X-Label:? field, if present, and (1) not at part of a thread tree, (2) at
6757
the top of a thread, or (3) ?X-Label:? is different from preceding
6758
message's ?X-Label:?.
6308
6759
6309
6760
%Z
6310
6761
6313
6764
%{fmt}
6314
6765
6315
6766
the date and time of the message is converted to sender's time zone, and
6316
``fmt'' is expanded by the library function ``strftime''; a leading bang
6767
?fmt? is expanded by the library function strftime(3); a leading bang
6317
6768
disables locales
6318
6769
6319
6770
%[fmt]
6320
6771
6321
6772
the date and time of the message is converted to the local time zone, and
6322
``fmt'' is expanded by the library function ``strftime''; a leading bang
6773
?fmt? is expanded by the library function strftime(3); a leading bang
6323
6774
disables locales
6324
6775
6325
6776
%(fmt)
6326
6777
6327
the local date and time when the message was received. ``fmt'' is expanded
6328
by the library function ``strftime''; a leading bang disables locales
6778
the local date and time when the message was received. ?fmt? is expanded by
6779
the library function strftime(3); a leading bang disables locales
6329
6780
6330
6781
%<fmt>
6331
6782
6332
the current local time. ``fmt'' is expanded by the library function
6333
``strftime''; a leading bang disables locales.
6783
the current local time. ?fmt? is expanded by the library function strftime
6784
(3); a leading bang disables locales.
6334
6785
6335
6786
%>X
6336
6787
6337
right justify the rest of the string and pad with character "X"
6788
right justify the rest of the string and pad with character ?X?
6338
6789
6339
6790
%|X
6340
6791
6341
pad to the end of the line with character "X"
6792
pad to the end of the line with character ?X?
6342
6793
6343
6794
%*X
6344
6795
6345
soft-fill with character "X" as pad
6796
soft-fill with character ?X? as pad
6346
6797
6347
`Soft-fill' deserves some explanation. Normal right-justification will print
6348
everything to the left of the %>, displaying padding and the whatever lies to
6349
the right only if there's room. By contrast, soft-fill gives priority to the
6798
?Soft-fill? deserves some explanation: Normal right-justification will print
6799
everything to the left of the ?%>?, displaying padding and whatever lies to the
6800
right only if there's room. By contrast, soft-fill gives priority to the
6350
6801
right-hand side, guaranteeing space to display it and showing padding only if
6351
6802
there's still room. If necessary, soft-fill will eat text leftwards to make
6352
6803
room for rightward text.
6353
6804
6354
Note that these expandos are supported in ``save-hook'', ``fcc-hook'' and ``
6355
fcc-save-hook'', too.
6356
6357
See also: ``$to_chars''.
6358
6359
3.101. ispell
6805
Note that these expandos are supported in ?save-hook?, ?fcc-hook? and ?
6806
fcc-save-hook?, too.
6807
6808
3.102. ispell
6360
6809
6361
6810
Type: path
6362
Default: "ispell"
6811
Default: ?ispell?
6363
6812
6364
6813
How to invoke ispell (GNU's spell-checking software).
6365
6814
6366
3.102. keep_flagged
6815
3.103. keep_flagged
6367
6816
6368
6817
Type: boolean
6369
6818
Default: no
6370
6819
6371
6820
If set, read messages marked as flagged will not be moved from your spool
6372
mailbox to your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
6821
mailbox to your $mbox mailbox, or as a result of a ?mbox-hook? command.
6373
6822
6374
3.103. locale
6823
3.104. locale
6375
6824
6376
6825
Type: string
6377
Default: "C"
6826
Default: ?C?
6378
6827
6379
6828
The locale used by strftime(3) to format dates. Legal values are the strings
6380
your system accepts for the locale variable LC_TIME.
6829
your system accepts for the locale environment variable $LC_TIME.
6381
6830
6382
3.104. mail_check
6831
3.105. mail_check
6383
6832
6384
6833
Type: number
6385
6834
Default: 5
6386
6835
6387
6836
This variable configures how often (in seconds) mutt should look for new mail.
6388
Also see the ``$timeout'' variable.
6837
Also see the $timeout variable.
6389
6838
6390
3.105. mailcap_path
6839
3.106. mailcap_path
6391
6840
6392
6841
Type: string
6393
Default: ""
6842
Default: (empty)
6394
6843
6395
6844
This variable specifies which files to consult when attempting to display MIME
6396
6845
bodies not directly supported by Mutt.
6397
6846
6398
3.106. mailcap_sanitize
6847
3.107. mailcap_sanitize
6399
6848
6400
6849
Type: boolean
6401
6850
Default: yes
6406
6855
6407
6856
DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING!
6408
6857
6409
3.107. header_cache
6858
3.108. header_cache
6410
6859
6411
6860
Type: path
6412
Default: ""
6413
6414
The header_cache variable points to the header cache database. If header_cache
6415
points to a directory it will contain a header cache database per folder. If
6416
header_cache points to a file that file will be a single global header cache.
6417
By default it is unset so no header caching will be used.
6418
6419
3.108. maildir_header_cache_verify
6861
Default: (empty)
6862
6863
This variable points to the header cache database. If pointing to a directory
6864
Mutt will contain a header cache database file per folder, if pointing to a
6865
file that file will be a single global header cache. By default it is unset so
6866
no header caching will be used.
6867
6868
Header caching can greatly improve speed when opening POP, IMAP MH or Maildir
6869
folders, see ?caching? for details.
6870
6871
3.109. maildir_header_cache_verify
6420
6872
6421
6873
Type: boolean
6422
6874
Default: yes
6423
6875
6424
6876
Check for Maildir unaware programs other than mutt having modified maildir
6425
6877
files when the header cache is in use. This incurs one stat(2) per message
6426
every time the folder is opened.
6878
every time the folder is opened (which can be very slow for NFS folders).
6427
6879
6428
3.109. header_cache_pagesize
6880
3.110. header_cache_pagesize
6429
6881
6430
6882
Type: string
6431
Default: "16384"
6883
Default: ?16384?
6432
6884
6433
6885
When mutt is compiled with either gdbm or bdb4 as the header cache backend,
6434
6886
this option changes the database page size. Too large or too small values can
6435
6887
waste space, memory, or CPU time. The default should be more or less optimal
6436
6888
for most use cases.
6437
6889
6438
3.110. header_cache_compress
6890
3.111. header_cache_compress
6439
6891
6440
6892
Type: boolean
6441
6893
Default: yes
6442
6894
6443
When mutt is compiled with qdbm as header cache backend, this option determines
6444
whether the database will be compressed. Compression results in database files
6445
roughly being one fifth of the usual diskspace, but the uncompression can
6446
result in a slower opening of cached folder(s).
6895
When mutt is compiled with qdbm or tokyocabinet as header cache backend, this
6896
option determines whether the database will be compressed. Compression results
6897
in database files roughly being one fifth of the usual diskspace, but the
6898
uncompression can result in a slower opening of cached folder(s) which in
6899
general is still much faster than opening non header cached folders.
6447
6900
6448
3.111. maildir_trash
6901
3.112. maildir_trash
6449
6902
6450
6903
Type: boolean
6451
6904
Default: no
6452
6905
6453
If set, messages marked as deleted will be saved with the maildir (T)rashed
6454
flag instead of unlinked. NOTE: this only applies to maildir-style mailboxes.
6906
If set, messages marked as deleted will be saved with the maildir trashed flag
6907
instead of unlinked. Note: this only applies to maildir-style mailboxes.
6455
6908
Setting it will have no effect on other mailbox types.
6456
6909
6457
3.112. mark_old
6910
3.113. mark_old
6458
6911
6459
6912
Type: boolean
6460
6913
Default: yes
6461
6914
6462
Controls whether or not mutt marks newunread messages as old if you exit a
6915
Controls whether or not mutt marks new unread messages as old if you exit a
6463
6916
mailbox without reading them. With this option set, the next time you start
6464
mutt, the messages will show up with an "O" next to them in the index menu,
6917
mutt, the messages will show up with an ?O? next to them in the index menu,
6465
6918
indicating that they are old.
6466
6919
6467
3.113. markers
6920
3.114. markers
6468
6921
6469
6922
Type: boolean
6470
6923
Default: yes
6471
6924
6472
Controls the display of wrapped lines in the internal pager. If set, a ``+''
6473
marker is displayed at the beginning of wrapped lines. Also see the ``
6474
$smart_wrap'' variable.
6475
6476
3.114. mask
6925
Controls the display of wrapped lines in the internal pager. If set, a ?+?
6926
marker is displayed at the beginning of wrapped lines.
6927
6928
Also see the $smart_wrap variable.
6929
6930
3.115. mask
6477
6931
6478
6932
Type: regular expression
6479
Default: "!^\.[^.]"
6933
Default: ?!^\.[^.]?
6480
6934
6481
6935
A regular expression used in the file browser, optionally preceded by the not
6482
operator ``!''. Only files whose names match this mask will be shown. The match
6936
operator ?!?. Only files whose names match this mask will be shown. The match
6483
6937
is always case-sensitive.
6484
6938
6485
3.115. mbox
6939
3.116. mbox
6486
6940
6487
6941
Type: path
6488
Default: "~/mbox"
6489
6490
This specifies the folder into which read mail in your ``$spoolfile'' folder
6491
will be appended.
6492
6493
3.116. mbox_type
6942
Default: ??/mbox?
6943
6944
This specifies the folder into which read mail in your $spoolfile folder will
6945
be appended.
6946
6947
Also see the $move variable.
6948
6949
3.117. mbox_type
6494
6950
6495
6951
Type: folder magic
6496
6952
Default: mbox
6497
6953
6498
The default mailbox type used when creating new folders. May be any of mbox,
6499
MMDF, MH and Maildir.
6954
The default mailbox type used when creating new folders. May be any of ?mbox?,
6955
?MMDF?, ?MH? and ?Maildir?.
6500
6956
6501
3.117. metoo
6957
3.118. metoo
6502
6958
6503
6959
Type: boolean
6504
6960
Default: no
6505
6961
6506
If unset, Mutt will remove your address (see the ``alternates'' command) from
6507
the list of recipients when replying to a message.
6962
If unset, Mutt will remove your address (see the ?alternates? command) from the
6963
list of recipients when replying to a message.
6508
6964
6509
3.118. menu_context
6965
3.119. menu_context
6510
6966
6511
6967
Type: number
6512
6968
Default: 0
6513
6969
6514
6970
This variable controls the number of lines of context that are given when
6515
scrolling through menus. (Similar to ``$pager_context''.)
6971
scrolling through menus. (Similar to $pager_context.)
6516
6972
6517
3.119. menu_move_off
6973
3.120. menu_move_off
6518
6974
6519
6975
Type: boolean
6520
6976
Default: yes
6523
6979
the screen, unless there are less entries than lines. When set, the bottom
6524
6980
entry may move off the bottom.
6525
6981
6526
3.120. menu_scroll
6982
3.121. menu_scroll
6527
6983
6528
6984
Type: boolean
6529
6985
Default: no
6533
6989
previous page of the menu is displayed (useful for slow links to avoid many
6534
6990
redraws).
6535
6991
6536
3.121. meta_key
6992
3.122. meta_key
6537
6993
6538
6994
Type: boolean
6539
6995
Default: no
6540
6996
6541
6997
If set, forces Mutt to interpret keystrokes with the high bit (bit 8) set as if
6542
the user had pressed the ESC key and whatever key remains after having the high
6998
the user had pressed the Esc key and whatever key remains after having the high
6543
6999
bit removed. For example, if the key pressed has an ASCII value of 0xf8, then
6544
this is treated as if the user had pressed ESC then ``x''. This is because the
6545
result of removing the high bit from ``0xf8'' is ``0x78'', which is the ASCII
6546
character ``x''.
7000
this is treated as if the user had pressed Esc then ?x?. This is because the
7001
result of removing the high bit from 0xf8 is 0x78, which is the ASCII character
7002
?x?.
6547
7003
6548
3.122. mh_purge
7004
3.123. mh_purge
6549
7005
6550
7006
Type: boolean
6551
7007
Default: no
6552
7008
6553
7009
When unset, mutt will mimic mh's behaviour and rename deleted messages to ,<old
6554
file name> in mh folders instead of really deleting them. If the variable is
6555
set, the message files will simply be deleted.
6556
6557
3.123. mh_seq_flagged
7010
file name> in mh folders instead of really deleting them. This leaves the
7011
message on disk but makes programs reading the folder ignore it. If the
7012
variable is set, the message files will simply be deleted.
7013
7014
This option is similar to $maildir_trash for Maildir folders.
7015
7016
3.124. mh_seq_flagged
6558
7017
6559
7018
Type: string
6560
Default: "flagged"
7019
Default: ?flagged?
6561
7020
6562
7021
The name of the MH sequence used for flagged messages.
6563
7022
6564
3.124. mh_seq_replied
7023
3.125. mh_seq_replied
6565
7024
6566
7025
Type: string
6567
Default: "replied"
7026
Default: ?replied?
6568
7027
6569
7028
The name of the MH sequence used to tag replied messages.
6570
7029
6571
3.125. mh_seq_unseen
7030
3.126. mh_seq_unseen
6572
7031
6573
7032
Type: string
6574
Default: "unseen"
7033
Default: ?unseen?
6575
7034
6576
7035
The name of the MH sequence used for unseen messages.
6577
7036
6578
3.126. mime_forward
7037
3.127. mime_forward
6579
7038
6580
7039
Type: quadoption
6581
7040
Default: no
6582
7041
6583
When set, the message you are forwarding will be attached as a separate MIME
6584
part instead of included in the main body of the message. This is useful for
6585
forwarding MIME messages so the receiver can properly view the message as it
6586
was delivered to you. If you like to switch between MIME and not MIME from mail
6587
to mail, set this variable to ask-no or ask-yes.
6588
6589
Also see ``$forward_decode'' and ``$mime_forward_decode''.
6590
6591
3.127. mime_forward_decode
7042
When set, the message you are forwarding will be attached as a separate message
7043
/rfc822 MIME part instead of included in the main body of the message. This is
7044
useful for forwarding MIME messages so the receiver can properly view the
7045
message as it was delivered to you. If you like to switch between MIME and not
7046
MIME from mail to mail, set this variable to ?ask-no? or ?ask-yes?.
7047
7048
Also see $forward_decode and $mime_forward_decode.
7049
7050
3.128. mime_forward_decode
6592
7051
6593
7052
Type: boolean
6594
7053
Default: no
6595
7054
6596
7055
Controls the decoding of complex MIME messages into text/plain when forwarding
6597
a message while ``$mime_forward'' is set. Otherwise ``$forward_decode'' is used
7056
a message while $mime_forward is set. Otherwise $forward_decode is used
6598
7057
instead.
6599
7058
6600
3.128. mime_forward_rest
7059
3.129. mime_forward_rest
6601
7060
6602
7061
Type: quadoption
6603
7062
Default: yes
6604
7063
6605
When forwarding multiple attachments of a MIME message from the recvattach
7064
When forwarding multiple attachments of a MIME message from the attachment
6606
7065
menu, attachments which cannot be decoded in a reasonable manner will be
6607
7066
attached to the newly composed message if this option is set.
6608
7067
6609
3.129. mix_entry_format
7068
3.130. mix_entry_format
6610
7069
6611
7070
Type: string
6612
Default: "%4n %c %-16s %a"
7071
Default: ?%4n %c %-16s %a?
6613
7072
6614
7073
This variable describes the format of a remailer line on the mixmaster chain
6615
selection screen. The following printf-like sequences are supported:
7074
selection screen. The following printf(3)-like sequences are supported:
6616
7075
6617
7076
%n
6618
7077
6630
7089
6631
7090
The remailer's e-mail address.
6632
7091
6633
3.130. mixmaster
7092
3.131. mixmaster
6634
7093
6635
7094
Type: path
6636
Default: "mixmaster"
7095
Default: ?mixmaster?
6637
7096
6638
7097
This variable contains the path to the Mixmaster binary on your system. It is
6639
7098
used with various sets of parameters to gather the list of known remailers, and
6640
7099
to finally send a message through the mixmaster chain.
6641
7100
6642
3.131. move
7101
3.132. move
6643
7102
6644
7103
Type: quadoption
6645
Default: ask-no
7104
Default: no
6646
7105
6647
7106
Controls whether or not Mutt will move read messages from your spool mailbox to
6648
your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
7107
your $mbox mailbox, or as a result of a ?mbox-hook? command.
6649
7108
6650
3.132. message_cachedir
7109
3.133. message_cachedir
6651
7110
6652
7111
Type: path
6653
Default: ""
7112
Default: (empty)
6654
7113
6655
7114
Set this to a directory and mutt will cache copies of messages from your IMAP
6656
and POP servers here. You are free to remove entries at any time, for instance
6657
if stale entries accumulate because you have deleted messages with another mail
6658
client.
6659
6660
3.133. message_cache_clean
7115
and POP servers here. You are free to remove entries at any time.
7116
7117
When setting this variable to a directory, mutt needs to fetch every remote
7118
message only once and can perform regular expression searches as fast as for
7119
local folders.
7120
7121
Also see the $message_cache_clean variable.
7122
7123
3.134. message_cache_clean
6661
7124
6662
7125
Type: boolean
6663
7126
Default: no
6664
7127
6665
If set, mutt will clean out obsolete entries from the cache when the mailbox is
6666
synchronized. You probably only want to set it every once in a while, since it
6667
can be a little slow.
7128
If set, mutt will clean out obsolete entries from the message cache when the
7129
mailbox is synchronized. You probably only want to set it every once in a
7130
while, since it can be a little slow (especially for large folders).
6668
7131
6669
3.134. message_format
7132
3.135. message_format
6670
7133
6671
7134
Type: string
6672
Default: "%s"
6673
6674
This is the string displayed in the ``attachment'' menu for attachments of type
6675
message/rfc822. For a full listing of defined printf()-like sequences see the
6676
section on ``$index_format''.
6677
6678
3.135. narrow_tree
7135
Default: ?%s?
7136
7137
This is the string displayed in the ?attachment? menu for attachments of type
7138
message/rfc822. For a full listing of defined printf(3)-like sequences see the
7139
section on $index_format.
7140
7141
3.136. narrow_tree
6679
7142
6680
7143
Type: boolean
6681
7144
Default: no
6683
7146
This variable, when set, makes the thread tree narrower, allowing deeper
6684
7147
threads to fit on the screen.
6685
7148
6686
3.136. net_inc
7149
3.137. net_inc
6687
7150
6688
7151
Type: number
6689
7152
Default: 10
6690
7153
6691
7154
Operations that expect to transfer a large amount of data over the network will
6692
update their progress every net_inc kilobytes. If set to 0, no progress
7155
update their progress every $net_inc kilobytes. If set to 0, no progress
6693
7156
messages will be displayed.
6694
7157
6695
See also ``$read_inc'' and ``$write_inc''.
7158
See also $read_inc, $write_inc and $net_inc.
6696
7159
6697
3.137. pager
7160
3.138. pager
6698
7161
6699
7162
Type: path
6700
Default: "builtin"
7163
Default: ?builtin?
6701
7164
6702
This variable specifies which pager you would like to use to view messages.
6703
builtin means to use the builtin pager, otherwise this variable should specify
6704
the pathname of the external pager you would like to use.
7165
This variable specifies which pager you would like to use to view messages. The
7166
value ?builtin? means to use the builtin pager, otherwise this variable should
7167
specify the pathname of the external pager you would like to use.
6705
7168
6706
7169
Using an external pager may have some disadvantages: Additional keystrokes are
6707
7170
necessary because you can't call mutt functions directly from the pager, and
6708
7171
screen resizes cause lines longer than the screen width to be badly formatted
6709
7172
in the help menu.
6710
7173
6711
3.138. pager_context
7174
3.139. pager_context
6712
7175
6713
7176
Type: number
6714
7177
Default: 0
6718
7181
will display the line after the last one on the screen at the top of the next
6719
7182
page (0 lines of context).
6720
7183
6721
3.139. pager_format
7184
3.140. pager_format
6722
7185
6723
7186
Type: string
6724
Default: "-%Z- %C/%m: %-20.20n %s%* -- (%P)"
7187
Default: ?-%Z- %C/%m: %-20.20n %s%* -- (%P)?
6725
7188
6726
This variable controls the format of the one-line message ``status'' displayed
7189
This variable controls the format of the one-line message ?status? displayed
6727
7190
before each message in either the internal or an external pager. The valid
6728
sequences are listed in the ``$index_format'' section.
7191
sequences are listed in the $index_format section.
6729
7192
6730
3.140. pager_index_lines
7193
3.141. pager_index_lines
6731
7194
6732
7195
Type: number
6733
7196
Default: 0
6738
7201
context of a few messages before and after the message. This is useful, for
6739
7202
example, to determine how many messages remain to be read in the current
6740
7203
thread. One of the lines is reserved for the status bar from the index, so a
6741
pager_index_lines of 6 will only show 5 lines of the actual index. A value of 0
6742
results in no index being shown. If the number of messages in the current
6743
folder is less than pager_index_lines, then the index will only use as many
6744
lines as it needs.
7204
setting of 6 will only show 5 lines of the actual index. A value of 0 results
7205
in no index being shown. If the number of messages in the current folder is
7206
less than $pager_index_lines, then the index will only use as many lines as it
7207
needs.
6745
7208
6746
3.141. pager_stop
7209
3.142. pager_stop
6747
7210
6748
7211
Type: boolean
6749
7212
Default: no
6750
7213
6751
7214
When set, the internal-pager will not move to the next message when you are at
6752
the end of a message and invoke the next-page function.
7215
the end of a message and invoke the <next-page> function.
6753
7216
6754
3.142. crypt_autosign
7217
3.143. crypt_autosign
6755
7218
6756
7219
Type: boolean
6757
7220
Default: no
6758
7221
6759
7222
Setting this variable will cause Mutt to always attempt to cryptographically
6760
sign outgoing messages. This can be overridden by use of the pgp-menu, when
6761
signing is not required or encryption is requested as well. If ``
6762
$smime_is_default'' is set, then OpenSSL is used instead to create S/MIME
6763
messages and settings can be overridden by use of the smime-menu. (Crypto only)
7223
sign outgoing messages. This can be overridden by use of the pgp menu, when
7224
signing is not required or encryption is requested as well. If
7225
$smime_is_default is set, then OpenSSL is used instead to create S/MIME
7226
messages and settings can be overridden by use of the smime menu instead of the
7227
pgp menu. (Crypto only)
6764
7228
6765
3.143. crypt_autoencrypt
7229
3.144. crypt_autoencrypt
6766
7230
6767
7231
Type: boolean
6768
7232
Default: no
6769
7233
6770
7234
Setting this variable will cause Mutt to always attempt to PGP encrypt outgoing
6771
messages. This is probably only useful in connection to the send-hook command.
6772
It can be overridden by use of the pgp-menu, when encryption is not required or
6773
signing is requested as well. IF ``$smime_is_default'' is set, then OpenSSL is
6774
used instead to create S/MIME messages and settings can be overridden by use of
6775
the smime-menu. (Crypto only)
7235
messages. This is probably only useful in connection to the ?send-hook?
7236
command. It can be overridden by use of the pgp menu, when encryption is not
7237
required or signing is requested as well. If $smime_is_default is set, then
7238
OpenSSL is used instead to create S/MIME messages and settings can be
7239
overridden by use of the smime menu instead. (Crypto only)
6776
7240
6777
3.144. pgp_ignore_subkeys
7241
3.145. pgp_ignore_subkeys
6778
7242
6779
7243
Type: boolean
6780
7244
Default: yes
6783
7247
principal key will inherit the subkeys' capabilities. Unset this if you want to
6784
7248
play interesting key selection games. (PGP only)
6785
7249
6786
3.145. crypt_replyencrypt
7250
3.146. crypt_replyencrypt
6787
7251
6788
7252
Type: boolean
6789
7253
Default: yes
6791
7255
If set, automatically PGP or OpenSSL encrypt replies to messages which are
6792
7256
encrypted. (Crypto only)
6793
7257
6794
3.146. crypt_replysign
7258
3.147. crypt_replysign
6795
7259
6796
7260
Type: boolean
6797
7261
Default: no
6801
7265
Note: this does not work on messages that are encrypted and signed! (Crypto
6802
7266
only)
6803
7267
6804
3.147. crypt_replysignencrypted
7268
3.148. crypt_replysignencrypted
6805
7269
6806
7270
Type: boolean
6807
7271
Default: no
6808
7272
6809
7273
If set, automatically PGP or OpenSSL sign replies to messages which are
6810
encrypted. This makes sense in combination with ``$crypt_replyencrypt'',
6811
because it allows you to sign all messages which are automatically encrypted.
6812
This works around the problem noted in ``$crypt_replysign'', that mutt is not
6813
able to find out whether an encrypted message is also signed. (Crypto only)
7274
encrypted. This makes sense in combination with $crypt_replyencrypt, because it
7275
allows you to sign all messages which are automatically encrypted. This works
7276
around the problem noted in $crypt_replysign, that mutt is not able to find out
7277
whether an encrypted message is also signed. (Crypto only)
6814
7278
6815
3.148. crypt_timestamp
7279
3.149. crypt_timestamp
6816
7280
6817
7281
Type: boolean
6818
7282
Default: yes
6821
7285
output, so spoofing such lines is more difficult. If you are using colors to
6822
7286
mark these lines, and rely on these, you may unset this setting. (Crypto only)
6823
7287
6824
3.149. pgp_use_gpg_agent
7288
3.150. pgp_use_gpg_agent
6825
7289
6826
7290
Type: boolean
6827
7291
Default: no
6828
7292
6829
If set, mutt will use a possibly-running gpg-agent process. (PGP only)
7293
If set, mutt will use a possibly-running gpg-agent(1) process. (PGP only)
6830
7294
6831
3.150. crypt_verify_sig
7295
3.151. crypt_verify_sig
6832
7296
6833
7297
Type: quadoption
6834
7298
Default: yes
6835
7299
6836
If ``yes'', always attempt to verify PGP or S/MIME signatures. If ``ask'', ask
6837
whether or not to verify the signature. If ``no'', never attempt to verify
7300
If ?yes?, always attempt to verify PGP or S/MIME signatures. If ?ask-*?, ask
7301
whether or not to verify the signature. If \Fi?no?, never attempt to verify
6838
7302
cryptographic signatures. (Crypto only)
6839
7303
6840
3.151. smime_is_default
7304
3.152. smime_is_default
6841
7305
6842
7306
Type: boolean
6843
7307
Default: no
6848
7312
same application that was used to sign/encrypt the original message. (Note that
6849
7313
this variable can be overridden by unsetting $crypt_autosmime.) (S/MIME only)
6850
7314
6851
3.152. smime_ask_cert_label
7315
3.153. smime_ask_cert_label
6852
7316
6853
7317
Type: boolean
6854
7318
Default: yes
6857
7321
certificate about to be added to the database or not. It is set by default. (S/
6858
7322
MIME only)
6859
7323
6860
3.153. smime_decrypt_use_default_key
7324
3.154. smime_decrypt_use_default_key
6861
7325
6862
7326
Type: boolean
6863
7327
Default: yes
6864
7328
6865
7329
If set (default) this tells mutt to use the default key for decryption.
6866
Otherwise, if manage multiple certificate-key-pairs, mutt will try to use the
7330
Otherwise, if managing multiple certificate-key-pairs, mutt will try to use the
6867
7331
mailbox-address to determine the key to use. It will ask you to supply a key,
6868
7332
if it can't find one. (S/MIME only)
6869
7333
6870
3.154. pgp_entry_format
7334
3.155. pgp_entry_format
6871
7335
6872
7336
Type: string
6873
Default: "%4n %t%f %4l/0x%k %-4a %2c %u"
7337
Default: ?%4n %t%f %4l/0x%k %-4a %2c %u?
6874
7338
6875
7339
This variable allows you to customize the PGP key selection menu to your
6876
personal taste. This string is similar to ``$index_format'', but has its own
6877
set of printf()-like sequences:
7340
personal taste. This string is similar to $index_format, but has its own set of
7341
printf(3)-like sequences:
6878
7342
6879
7343
%n
6880
7344
6914
7378
6915
7379
(PGP only)
6916
7380
6917
3.155. pgp_good_sign
7381
3.156. pgp_good_sign
6918
7382
6919
7383
Type: regular expression
6920
Default: ""
7384
Default: (empty)
6921
7385
6922
7386
If you assign a text to this variable, then a PGP signature is only considered
6923
7387
verified if the output from $pgp_verify_command contains the text. Use this
6924
7388
variable if the exit code from the command is 0 even for bad signatures. (PGP
6925
7389
only)
6926
7390
6927
3.156. pgp_check_exit
7391
3.157. pgp_check_exit
6928
7392
6929
7393
Type: boolean
6930
7394
Default: yes
6932
7396
If set, mutt will check the exit code of the PGP subprocess when signing or
6933
7397
encrypting. A non-zero exit code means that the subprocess failed. (PGP only)
6934
7398
6935
3.157. pgp_long_ids
7399
3.158. pgp_long_ids
6936
7400
6937
7401
Type: boolean
6938
7402
Default: no
6939
7403
6940
If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs. (PGP
7404
If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs. (PGP
6941
7405
only)
6942
7406
6943
3.158. pgp_retainable_sigs
7407
3.159. pgp_retainable_sigs
6944
7408
6945
7409
Type: boolean
6946
7410
Default: no
6952
7416
the outer layer (multipart/encrypted) can be easily removed, while the inner
6953
7417
multipart/signed part is retained. (PGP only)
6954
7418
6955
3.159. pgp_autoinline
7419
3.160. pgp_autoinline
6956
7420
6957
7421
Type: boolean
6958
7422
Default: no
6959
7423
6960
7424
This option controls whether Mutt generates old-style inline (traditional) PGP
6961
7425
encrypted or signed messages under certain circumstances. This can be
6962
overridden by use of the pgp-menu, when inline is not required.
7426
overridden by use of the pgp menu, when inline is not required.
6963
7427
6964
7428
Note that Mutt might automatically use PGP/MIME for messages which consist of
6965
7429
more than a single MIME part. Mutt can be configured to ask before sending PGP/
6966
MIME messages when inline (traditional) would not work. See also: ``
6967
$pgp_mime_auto''.
6968
6969
Also note that using the old-style PGP message format is stronglydeprecated.
7430
MIME messages when inline (traditional) would not work.
7431
7432
Also see the $pgp_mime_auto variable.
7433
7434
Also note that using the old-style PGP message format is strongly deprecated.
6970
7435
(PGP only)
6971
7436
6972
3.160. pgp_replyinline
7437
3.161. pgp_replyinline
6973
7438
6974
7439
Type: boolean
6975
7440
Default: no
6976
7441
6977
7442
Setting this variable will cause Mutt to always attempt to create an inline
6978
7443
(traditional) message when replying to a message which is PGP encrypted/signed
6979
inline. This can be overridden by use of the pgp-menu, when inline is not
7444
inline. This can be overridden by use of the pgp menu, when inline is not
6980
7445
required. This option does not automatically detect if the (replied-to) message
6981
7446
is inline; instead it relies on Mutt internals for previously checked/flagged
6982
7447
messages.
6983
7448
6984
7449
Note that Mutt might automatically use PGP/MIME for messages which consist of
6985
7450
more than a single MIME part. Mutt can be configured to ask before sending PGP/
6986
MIME messages when inline (traditional) would not work. See also: ``
6987
$pgp_mime_auto''.
6988
6989
Also note that using the old-style PGP message format is stronglydeprecated.
7451
MIME messages when inline (traditional) would not work.
7452
7453
Also see the $pgp_mime_auto variable.
7454
7455
Also note that using the old-style PGP message format is strongly deprecated.
6990
7456
(PGP only)
6991
7457
6992
3.161. pgp_show_unusable
7458
3.162. pgp_show_unusable
6993
7459
6994
7460
Type: boolean
6995
7461
Default: yes
6996
7462
6997
7463
If set, mutt will display non-usable keys on the PGP key selection menu. This
6998
7464
includes keys which have been revoked, have expired, or have been marked as
6999
``disabled'' by the user. (PGP only)
7465
?disabled? by the user. (PGP only)
7000
7466
7001
3.162. pgp_sign_as
7467
3.163. pgp_sign_as
7002
7468
7003
7469
Type: string
7004
Default: ""
7470
Default: (empty)
7005
7471
7006
7472
If you have more than one key pair, this option allows you to specify which of
7007
7473
your private keys to use. It is recommended that you use the keyid form to
7008
specify your key (e.g., ``0x00112233''). (PGP only)
7474
specify your key (e.g. 0x00112233). (PGP only)
7009
7475
7010
3.163. pgp_strict_enc
7476
3.164. pgp_strict_enc
7011
7477
7012
7478
Type: boolean
7013
7479
Default: yes
7017
7483
with non-verifyable PGP signatures, so only change this if you know what you
7018
7484
are doing. (PGP only)
7019
7485
7020
3.164. pgp_timeout
7486
3.165. pgp_timeout
7021
7487
7022
7488
Type: number
7023
7489
Default: 300
7025
7491
The number of seconds after which a cached passphrase will expire if not used.
7026
7492
(PGP only)
7027
7493
7028
3.165. pgp_sort_keys
7494
3.166. pgp_sort_keys
7029
7495
7030
7496
Type: sort order
7031
7497
Default: address
7032
7498
7033
Specifies how the entries in the `pgp keys' menu are sorted. The following are
7034
legal values:
7499
Specifies how the entries in the pgp menu are sorted. The following are legal
7500
values:
7035
7501
7036
7502
address
7037
7503
7049
7515
7050
7516
sort by the trust of the key
7051
7517
7052
If you prefer reverse order of the above values, prefix it with `reverse-'.
7518
If you prefer reverse order of the above values, prefix it with ?reverse-?.
7053
7519
(PGP only)
7054
7520
7055
3.166. pgp_mime_auto
7521
3.167. pgp_mime_auto
7056
7522
7057
7523
Type: quadoption
7058
7524
Default: ask-yes
7061
7527
(signed/encrypted) message using PGP/MIME when inline (traditional) fails (for
7062
7528
any reason).
7063
7529
7064
Also note that using the old-style PGP message format is stronglydeprecated.
7530
Also note that using the old-style PGP message format is strongly deprecated.
7065
7531
(PGP only)
7066
7532
7067
3.167. pgp_auto_decode
7533
3.168. pgp_auto_decode
7068
7534
7069
7535
Type: boolean
7070
7536
Default: no
7073
7539
whenever the user performs an operation which ordinarily would result in the
7074
7540
contents of the message being operated on. For example, if the user displays a
7075
7541
pgp-traditional message which has not been manually checked with the
7076
check-traditional-pgp function, mutt will automatically check the message for
7542
<check-traditional-pgp> function, mutt will automatically check the message for
7077
7543
traditional pgp.
7078
7544
7079
3.168. pgp_decode_command
7545
3.169. pgp_decode_command
7080
7546
7081
7547
Type: string
7082
Default: ""
7548
Default: (empty)
7083
7549
7084
7550
This format strings specifies a command which is used to decode application/pgp
7085
7551
attachments.
7086
7552
7087
The PGP command formats have their own set of printf-like sequences:
7553
The PGP command formats have their own set of printf(3)-like sequences:
7088
7554
7089
7555
%p
7090
7556
7109
7575
One or more key IDs.
7110
7576
7111
7577
For examples on how to configure these formats for the various versions of PGP
7112
which are floating around, see the pgp*.rc and gpg.rc files in the samples/
7113
subdirectory which has been installed on your system alongside the
7578
which are floating around, see the pgp and gpg sample configuration files in
7579
the samples/ subdirectory which has been installed on your system alongside the
7114
7580
documentation. (PGP only)
7115
7581
7116
3.169. pgp_getkeys_command
7117
7118
Type: string
7119
Default: ""
7120
7121
This command is invoked whenever mutt will need public key information. %r is
7122
the only printf-like sequence used with this format. (PGP only)
7123
7124
3.170. pgp_verify_command
7125
7126
Type: string
7127
Default: ""
7128
7129
This command is used to verify PGP signatures. (PGP only)
7130
7131
3.171. pgp_decrypt_command
7132
7133
Type: string
7134
Default: ""
7135
7136
This command is used to decrypt a PGP encrypted message. (PGP only)
7137
7138
3.172. pgp_clearsign_command
7139
7140
Type: string
7141
Default: ""
7142
7143
This format is used to create a old-style "clearsigned" PGP message. Note that
7144
the use of this format is stronglydeprecated. (PGP only)
7145
7146
3.173. pgp_sign_command
7147
7148
Type: string
7149
Default: ""
7582
3.170. pgp_getkeys_command
7583
7584
Type: string
7585
Default: (empty)
7586
7587
This command is invoked whenever mutt will need public key information. Of the
7588
sequences supported by $pgp_decode_command, %r is the only printf(3)-like
7589
sequence used with this format. (PGP only)
7590
7591
3.171. pgp_verify_command
7592
7593
Type: string
7594
Default: (empty)
7595
7596
This command is used to verify PGP signatures.
7597
7598
This is a format string, see the $pgp_decode_command command for possible
7599
printf(3)-like sequences. (PGP only)
7600
7601
3.172. pgp_decrypt_command
7602
7603
Type: string
7604
Default: (empty)
7605
7606
This command is used to decrypt a PGP encrypted message.
7607
7608
This is a format string, see the $pgp_decode_command command for possible
7609
printf(3)-like sequences. (PGP only)
7610
7611
3.173. pgp_clearsign_command
7612
7613
Type: string
7614
Default: (empty)
7615
7616
This format is used to create a old-style ?clearsigned? PGP message. Note that
7617
the use of this format is strongly deprecated.
7618
7619
This is a format string, see the $pgp_decode_command command for possible
7620
printf(3)-like sequences. (PGP only)
7621
7622
3.174. pgp_sign_command
7623
7624
Type: string
7625
Default: (empty)
7150
7626
7151
7627
This command is used to create the detached PGP signature for a multipart/
7152
signed PGP/MIME body part. (PGP only)
7153
7154
3.174. pgp_encrypt_sign_command
7155
7156
Type: string
7157
Default: ""
7158
7159
This command is used to both sign and encrypt a body part. (PGP only)
7160
7161
3.175. pgp_encrypt_only_command
7162
7163
Type: string
7164
Default: ""
7165
7166
This command is used to encrypt a body part without signing it. (PGP only)
7167
7168
3.176. pgp_import_command
7169
7170
Type: string
7171
Default: ""
7628
signed PGP/MIME body part.
7629
7630
This is a format string, see the $pgp_decode_command command for possible
7631
printf(3)-like sequences. (PGP only)
7632
7633
3.175. pgp_encrypt_sign_command
7634
7635
Type: string
7636
Default: (empty)
7637
7638
This command is used to both sign and encrypt a body part.
7639
7640
This is a format string, see the $pgp_decode_command command for possible
7641
printf(3)-like sequences. (PGP only)
7642
7643
3.176. pgp_encrypt_only_command
7644
7645
Type: string
7646
Default: (empty)
7647
7648
This command is used to encrypt a body part without signing it.
7649
7650
This is a format string, see the $pgp_decode_command command for possible
7651
printf(3)-like sequences. (PGP only)
7652
7653
3.177. pgp_import_command
7654
7655
Type: string
7656
Default: (empty)
7172
7657
7173
7658
This command is used to import a key from a message into the user's public key
7174
ring. (PGP only)
7175
7176
3.177. pgp_export_command
7177
7178
Type: string
7179
Default: ""
7180
7181
This command is used to export a public key from the user's key ring. (PGP
7182
only)
7183
7184
3.178. pgp_verify_key_command
7185
7186
Type: string
7187
Default: ""
7659
ring.
7660
7661
This is a format string, see the $pgp_decode_command command for possible
7662
printf(3)-like sequences. (PGP only)
7663
7664
3.178. pgp_export_command
7665
7666
Type: string
7667
Default: (empty)
7668
7669
This command is used to export a public key from the user's key ring.
7670
7671
This is a format string, see the $pgp_decode_command command for possible
7672
printf(3)-like sequences. (PGP only)
7673
7674
3.179. pgp_verify_key_command
7675
7676
Type: string
7677
Default: (empty)
7188
7678
7189
7679
This command is used to verify key information from the key selection menu.
7190
(PGP only)
7191
7192
3.179. pgp_list_secring_command
7680
7681
This is a format string, see the $pgp_decode_command command for possible
7682
printf(3)-like sequences. (PGP only)
7683
7684
3.180. pgp_list_secring_command
7193
7685
7194
7686
Type: string
7195
Default: ""
7687
Default: (empty)
7196
7688
7197
7689
This command is used to list the secret key ring's contents. The output format
7198
must be analogous to the one used by gpg --list-keys --with-colons.
7690
must be analogous to the one used by:
7691
7692
gpg --list-keys --with-colons.
7693
7199
7694
7200
7695
This format is also generated by the pgpring utility which comes with mutt.
7201
(PGP only)
7202
7203
3.180. pgp_list_pubring_command
7696
7697
This is a format string, see the $pgp_decode_command command for possible
7698
printf(3)-like sequences. (PGP only)
7699
7700
3.181. pgp_list_pubring_command
7204
7701
7205
7702
Type: string
7206
Default: ""
7703
Default: (empty)
7207
7704
7208
7705
This command is used to list the public key ring's contents. The output format
7209
must be analogous to the one used by gpg --list-keys --with-colons.
7706
must be analogous to the one used by
7707
7708
gpg --list-keys --with-colons.
7709
7210
7710
7211
7711
This format is also generated by the pgpring utility which comes with mutt.
7212
(PGP only)
7213
7214
3.181. forward_decrypt
7712
7713
This is a format string, see the $pgp_decode_command command for possible
7714
printf(3)-like sequences. (PGP only)
7715
7716
3.182. forward_decrypt
7215
7717
7216
7718
Type: boolean
7217
7719
Default: yes
7218
7720
7219
Controls the handling of encrypted messages when forwarding a message. When
7220
set, the outer layer of encryption is stripped off. This variable is only used
7221
if ``$mime_forward'' is set and ``$mime_forward_decode'' is unset. (PGP only)
7721
Controls the handling of encrypted messages when forwarding a message. When set
7722
, the outer layer of encryption is stripped off. This variable is only used if
7723
$mime_forward is set and $mime_forward_decode is unset. (PGP only)
7222
7724
7223
3.182. smime_timeout
7725
3.183. smime_timeout
7224
7726
7225
7727
Type: number
7226
7728
Default: 300
7228
7730
The number of seconds after which a cached passphrase will expire if not used.
7229
7731
(S/MIME only)
7230
7732
7231
3.183. smime_encrypt_with
7733
3.184. smime_encrypt_with
7232
7734
7233
7735
Type: string
7234
Default: ""
7736
Default: (empty)
7235
7737
7236
7738
This sets the algorithm that should be used for encryption. Valid choices are
7237
"des", "des3", "rc2-40", "rc2-64", "rc2-128". If unset "3des" (TripleDES) is
7739
?des?, ?des3?, ?rc2-40?, ?rc2-64?, ?rc2-128?. If unset, ?3des? (TripleDES) is
7238
7740
used. (S/MIME only)
7239
7741
7240
3.184. smime_keys
7241
7242
Type: path
7243
Default: ""
7244
7245
Since there is no pubring/secring as with PGP, mutt has to handle storage ad
7246
retrieval of keys/certs by itself. This is very basic right now, and stores
7247
keys and certificates in two different directories, both named as the
7248
hash-value retrieved from OpenSSL. There is an index file which contains
7249
mailbox-address keyid pair, and which can be manually edited. This one points
7250
to the location of the private keys. (S/MIME only)
7251
7252
3.185. smime_ca_location
7253
7254
Type: path
7255
Default: ""
7742
3.185. smime_keys
7743
7744
Type: path
7745
Default: (empty)
7746
7747
Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
7748
storage and retrieval of keys/certs by itself. This is very basic right now,
7749
and stores keys and certificates in two different directories, both named as
7750
the hash-value retrieved from OpenSSL. There is an index file which contains
7751
mailbox-address keyid pair, and which can be manually edited. This option
7752
points to the location of the private keys. (S/MIME only)
7753
7754
3.186. smime_ca_location
7755
7756
Type: path
7757
Default: (empty)
7256
7758
7257
7759
This variable contains the name of either a directory, or a file which contains
7258
7760
trusted certificates for use with OpenSSL. (S/MIME only)
7259
7761
7260
3.186. smime_certificates
7762
3.187. smime_certificates
7261
7763
7262
7764
Type: path
7263
Default: ""
7765
Default: (empty)
7264
7766
7265
Since there is no pubring/secring as with PGP, mutt has to handle storage and
7266
retrieval of keys by itself. This is very basic right now, and keys and
7267
certificates are stored in two different directories, both named as the
7767
Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
7768
storage and retrieval of keys by itself. This is very basic right now, and keys
7769
and certificates are stored in two different directories, both named as the
7268
7770
hash-value retrieved from OpenSSL. There is an index file which contains
7269
mailbox-address keyid pairs, and which can be manually edited. This one points
7270
to the location of the certificates. (S/MIME only)
7771
mailbox-address keyid pairs, and which can be manually edited. This option
7772
points to the location of the certificates. (S/MIME only)
7271
7773
7272
3.187. smime_decrypt_command
7774
3.188. smime_decrypt_command
7273
7775
7274
7776
Type: string
7275
Default: ""
7777
Default: (empty)
7276
7778
7277
7779
This format string specifies a command which is used to decrypt application/
7278
7780
x-pkcs7-mime attachments.
7279
7781
7280
The OpenSSL command formats have their own set of printf-like sequences similar
7281
to PGP's:
7782
The OpenSSL command formats have their own set of printf(3)-like sequences
7783
similar to PGP's:
7282
7784
7283
7785
%f
7284
7786
7304
7806
%C
7305
7807
7306
7808
CA location: Depending on whether $smime_ca_location points to a directory
7307
or file, this expands to "-CApath $smime_ca_location" or "-CAfile
7308
$smime_ca_location".
7809
or file, this expands to ?-CApath $smime_ca_location? or ?-CAfile
7810
$smime_ca_location?.
7309
7811
7310
7812
For examples on how to configure these formats, see the smime.rc in the samples
7311
7813
/ subdirectory which has been installed on your system alongside the
7312
7814
documentation. (S/MIME only)
7313
7815
7314
3.188. smime_verify_command
7315
7316
Type: string
7317
Default: ""
7318
7319
This command is used to verify S/MIME signatures of type multipart/signed. (S/
7320
MIME only)
7321
7322
3.189. smime_verify_opaque_command
7323
7324
Type: string
7325
Default: ""
7816
3.189. smime_verify_command
7817
7818
Type: string
7819
Default: (empty)
7820
7821
This command is used to verify S/MIME signatures of type multipart/signed.
7822
7823
This is a format string, see the $smime_decrypt_command command for possible
7824
printf(3)-like sequences. (S/MIME only)
7825
7826
3.190. smime_verify_opaque_command
7827
7828
Type: string
7829
Default: (empty)
7326
7830
7327
7831
This command is used to verify S/MIME signatures of type application/
7328
x-pkcs7-mime. (S/MIME only)
7329
7330
3.190. smime_sign_command
7832
x-pkcs7-mime.
7833
7834
This is a format string, see the $smime_decrypt_command command for possible
7835
printf(3)-like sequences. (S/MIME only)
7836
7837
3.191. smime_sign_command
7331
7838
7332
7839
Type: string
7333
Default: ""
7840
Default: (empty)
7334
7841
7335
7842
This command is used to created S/MIME signatures of type multipart/signed,
7336
which can be read by all mail clients. (S/MIME only)
7337
7338
3.191. smime_sign_opaque_command
7843
which can be read by all mail clients.
7844
7845
This is a format string, see the $smime_decrypt_command command for possible
7846
printf(3)-like sequences. (S/MIME only)
7847
7848
3.192. smime_sign_opaque_command
7339
7849
7340
7850
Type: string
7341
Default: ""
7851
Default: (empty)
7342
7852
7343
7853
This command is used to created S/MIME signatures of type application/
7344
7854
x-pkcs7-signature, which can only be handled by mail clients supporting the S/
7345
MIME extension. (S/MIME only)
7346
7347
3.192. smime_encrypt_command
7348
7349
Type: string
7350
Default: ""
7351
7352
This command is used to create encrypted S/MIME messages. (S/MIME only)
7353
7354
3.193. smime_pk7out_command
7355
7356
Type: string
7357
Default: ""
7855
MIME extension.
7856
7857
This is a format string, see the $smime_decrypt_command command for possible
7858
printf(3)-like sequences. (S/MIME only)
7859
7860
3.193. smime_encrypt_command
7861
7862
Type: string
7863
Default: (empty)
7864
7865
This command is used to create encrypted S/MIME messages.
7866
7867
This is a format string, see the $smime_decrypt_command command for possible
7868
printf(3)-like sequences. (S/MIME only)
7869
7870
3.194. smime_pk7out_command
7871
7872
Type: string
7873
Default: (empty)
7358
7874
7359
7875
This command is used to extract PKCS7 structures of S/MIME signatures, in order
7360
to extract the public X509 certificate(s). (S/MIME only)
7361
7362
3.194. smime_get_cert_command
7363
7364
Type: string
7365
Default: ""
7366
7367
This command is used to extract X509 certificates from a PKCS7 structure. (S/
7368
MIME only)
7369
7370
3.195. smime_get_signer_cert_command
7371
7372
Type: string
7373
Default: ""
7876
to extract the public X509 certificate(s).
7877
7878
This is a format string, see the $smime_decrypt_command command for possible
7879
printf(3)-like sequences. (S/MIME only)
7880
7881
3.195. smime_get_cert_command
7882
7883
Type: string
7884
Default: (empty)
7885
7886
This command is used to extract X509 certificates from a PKCS7 structure.
7887
7888
This is a format string, see the $smime_decrypt_command command for possible
7889
printf(3)-like sequences. (S/MIME only)
7890
7891
3.196. smime_get_signer_cert_command
7892
7893
Type: string
7894
Default: (empty)
7374
7895
7375
7896
This command is used to extract only the signers X509 certificate from a S/MIME
7376
7897
signature, so that the certificate's owner may get compared to the email's
7377
'From'-field. (S/MIME only)
7378
7379
3.196. smime_import_cert_command
7380
7381
Type: string
7382
Default: ""
7383
7384
This command is used to import a certificate via smime_keys. (S/MIME only)
7385
7386
3.197. smime_get_cert_email_command
7387
7388
Type: string
7389
Default: ""
7898
?From:? field.
7899
7900
This is a format string, see the $smime_decrypt_command command for possible
7901
printf(3)-like sequences. (S/MIME only)
7902
7903
3.197. smime_import_cert_command
7904
7905
Type: string
7906
Default: (empty)
7907
7908
This command is used to import a certificate via smime_keys.
7909
7910
This is a format string, see the $smime_decrypt_command command for possible
7911
printf(3)-like sequences. (S/MIME only)
7912
7913
3.198. smime_get_cert_email_command
7914
7915
Type: string
7916
Default: (empty)
7390
7917
7391
7918
This command is used to extract the mail address(es) used for storing X509
7392
7919
certificates, and for verification purposes (to check whether the certificate
7393
was issued for the sender's mailbox). (S/MIME only)
7394
7395
3.198. smime_default_key
7920
was issued for the sender's mailbox).
7921
7922
This is a format string, see the $smime_decrypt_command command for possible
7923
printf(3)-like sequences. (S/MIME only)
7924
7925
3.199. smime_default_key
7396
7926
7397
7927
Type: string
7398
Default: ""
7928
Default: (empty)
7399
7929
7400
7930
This is the default key-pair to use for signing. This must be set to the keyid
7401
7931
(the hash-value that OpenSSL generates) to work properly (S/MIME only)
7402
7932
7403
3.199. ssl_client_cert
7933
3.200. ssl_client_cert
7404
7934
7405
7935
Type: path
7406
Default: ""
7936
Default: (empty)
7407
7937
7408
7938
The file containing a client certificate and its associated private key.
7409
7939
7410
3.200. ssl_force_tls
7940
3.201. ssl_force_tls
7411
7941
7412
7942
Type: boolean
7413
7943
Default: no
7415
7945
If this variable is set, Mutt will require that all connections to remote
7416
7946
servers be encrypted. Furthermore it will attempt to negotiate TLS even if the
7417
7947
server does not advertise the capability, since it would otherwise have to
7418
abort the connection anyway. This option supersedes ``$ssl_starttls''.
7948
abort the connection anyway. This option supersedes $ssl_starttls.
7419
7949
7420
3.201. ssl_starttls
7950
3.202. ssl_starttls
7421
7951
7422
7952
Type: quadoption
7423
7953
Default: yes
7426
7956
the capability. When unset, mutt will not attempt to use STARTTLS regardless of
7427
7957
the server's capabilities.
7428
7958
7429
3.202. certificate_file
7959
3.203. certificate_file
7430
7960
7431
7961
Type: path
7432
Default: "~/.mutt_certificates"
7962
Default: ??/.mutt_certificates?
7433
7963
7434
7964
This variable specifies the file where the certificates you trust are saved.
7435
7965
When an unknown certificate is encountered, you are asked if you accept it or
7437
7967
further connections are automatically accepted.
7438
7968
7439
7969
You can also manually add CA certificates in this file. Any server certificate
7440
that is signed with one of these CA certificates are also automatically
7970
that is signed with one of these CA certificates is also automatically
7441
7971
accepted.
7442
7972
7443
Example: set certificate_file=~/.mutt/certificates
7444
7445
3.203. ssl_usesystemcerts
7973
Example:
7974
7975
set certificate_file=~/.mutt/certificates
7976
7977
7978
3.204. ssl_usesystemcerts
7446
7979
7447
7980
Type: boolean
7448
7981
Default: yes
7449
7982
7450
7983
If set to yes, mutt will use CA certificates in the system-wide certificate
7451
store when checking if server certificate is signed by a trusted CA.
7984
store when checking if a server certificate is signed by a trusted CA.
7452
7985
7453
3.204. entropy_file
7986
3.205. entropy_file
7454
7987
7455
7988
Type: path
7456
Default: ""
7989
Default: (empty)
7457
7990
7458
7991
The file which includes random data that is used to initialize SSL library
7459
7992
functions.
7460
7993
7461
3.205. ssl_use_sslv2
7994
3.206. ssl_use_sslv2
7462
7995
7463
7996
Type: boolean
7464
7997
Default: yes
7466
7999
This variables specifies whether to attempt to use SSLv2 in the SSL
7467
8000
authentication process.
7468
8001
7469
3.206. ssl_use_sslv3
8002
3.207. ssl_use_sslv3
7470
8003
7471
8004
Type: boolean
7472
8005
Default: yes
7474
8007
This variables specifies whether to attempt to use SSLv3 in the SSL
7475
8008
authentication process.
7476
8009
7477
3.207. ssl_use_tlsv1
8010
3.208. ssl_use_tlsv1
7478
8011
7479
8012
Type: boolean
7480
8013
Default: yes
7482
8015
This variables specifies whether to attempt to use TLSv1 in the SSL
7483
8016
authentication process.
7484
8017
7485
3.208. ssl_min_dh_prime_bits
8018
3.209. ssl_min_dh_prime_bits
7486
8019
7487
8020
Type: number
7488
8021
Default: 0
7491
8024
any Diffie-Hellman key exchange. A value of 0 will use the default from the
7492
8025
GNUTLS library.
7493
8026
7494
3.209. ssl_ca_certificates_file
8027
3.210. ssl_ca_certificates_file
7495
8028
7496
8029
Type: path
7497
Default: ""
8030
Default: (empty)
7498
8031
7499
8032
This variable specifies a file containing trusted CA certificates. Any server
7500
certificate that is signed with one of these CA certificates are also
8033
certificate that is signed with one of these CA certificates is also
7501
8034
automatically accepted.
7502
8035
7503
Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
7504
7505
3.210. pipe_split
7506
7507
Type: boolean
7508
Default: no
7509
7510
Used in connection with the pipe-message command and the ``tag- prefix''
7511
operator. If this variable is unset, when piping a list of tagged messages Mutt
7512
will concatenate the messages and will pipe them as a single folder. When set,
7513
Mutt will pipe the messages one by one. In both cases the messages are piped in
7514
the current sorted order, and the ``$pipe_sep'' separator is added after each
7515
message.
7516
7517
3.211. pipe_decode
7518
7519
Type: boolean
7520
Default: no
7521
7522
Used in connection with the pipe-message command. When unset, Mutt will pipe
8036
Example:
8037
8038
set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
8039
8040
8041
3.211. pipe_split
8042
8043
Type: boolean
8044
Default: no
8045
8046
Used in connection with the <pipe-message> function following <tag-prefix>. If
8047
this variable is unset, when piping a list of tagged messages Mutt will
8048
concatenate the messages and will pipe them all concatenated. When set, Mutt
8049
will pipe the messages one by one. In both cases the messages are piped in the
8050
current sorted order, and the $pipe_sep separator is added after each message.
8051
8052
3.212. pipe_decode
8053
8054
Type: boolean
8055
Default: no
8056
8057
Used in connection with the <pipe-message> command. When unset, Mutt will pipe
7523
8058
the messages without any preprocessing. When set, Mutt will weed headers and
7524
will attempt to PGP/MIME decode the messages first.
8059
will attempt to decode the messages first.
7525
8060
7526
3.212. pipe_sep
8061
3.213. pipe_sep
7527
8062
7528
8063
Type: string
7529
Default: "\n"
8064
Default: ?\n?
7530
8065
7531
8066
The separator to add between messages when piping a list of tagged messages to
7532
8067
an external Unix command.
7533
8068
7534
3.213. pop_authenticators
8069
3.214. pop_authenticators
7535
8070
7536
8071
Type: string
7537
Default: ""
8072
Default: (empty)
7538
8073
7539
8074
This is a colon-delimited list of authentication methods mutt may attempt to
7540
8075
use to log in to an POP server, in the order mutt should try them.
7541
Authentication methods are either 'user', 'apop' or any SASL mechanism, eg
7542
'digest-md5', 'gssapi' or 'cram-md5'. This parameter is case-insensitive. If
7543
this parameter is unset (the default) mutt will try all available methods, in
7544
order from most-secure to least-secure.
7545
7546
Example: set pop_authenticators="digest-md5:apop:user"
7547
7548
3.214. pop_auth_try_all
8076
Authentication methods are either ?user?, ?apop? or any SASL mechanism, eg
8077
?digest-md5?, ?gssapi? or ?cram-md5?. This option is case-insensitive. If this
8078
option is unset (the default) mutt will try all available methods, in order
8079
from most-secure to least-secure.
8080
8081
Example:
8082
8083
set pop_authenticators="digest-md5:apop:user"
8084
8085
8086
3.215. pop_auth_try_all
7549
8087
7550
8088
Type: boolean
7551
8089
Default: yes
7552
8090
7553
If set, Mutt will try all available methods. When unset, Mutt will only fall
7554
back to other authentication methods if the previous methods are unavailable.
7555
If a method is available but authentication fails, Mutt will not connect to the
7556
POP server.
8091
If set, Mutt will try all available authentication methods. When unset, Mutt
8092
will only fall back to other authentication methods if the previous methods are
8093
unavailable. If a method is available but authentication fails, Mutt will not
8094
connect to the POP server.
7557
8095
7558
3.215. pop_checkinterval
8096
3.216. pop_checkinterval
7559
8097
7560
8098
Type: number
7561
8099
Default: 60
7563
8101
This variable configures how often (in seconds) mutt should look for new mail
7564
8102
in the currently selected mailbox if it is a POP mailbox.
7565
8103
7566
3.216. pop_delete
8104
3.217. pop_delete
7567
8105
7568
8106
Type: quadoption
7569
8107
Default: ask-no
7570
8108
7571
8109
If set, Mutt will delete successfully downloaded messages from the POP server
7572
when using the fetch-mail function. When unset, Mutt will download messages but
7573
also leave them on the POP server.
8110
when using the <fetch-mail> function. When unset, Mutt will download messages
8111
but also leave them on the POP server.
7574
8112
7575
3.217. pop_host
8113
3.218. pop_host
7576
8114
7577
8115
Type: string
7578
Default: ""
8116
Default: (empty)
7579
8117
7580
The name of your POP server for the fetch-mail function. You can also specify
8118
The name of your POP server for the <fetch-mail> function. You can also specify
7581
8119
an alternative port, username and password, ie:
7582
8120
7583
8121
[pop[s]://][username[:password]@]popserver[:port]
7584
8122
7585
3.218. pop_last
8123
8124
where ?[...]? denotes an optional part.
8125
8126
3.219. pop_last
7586
8127
7587
8128
Type: boolean
7588
8129
Default: no
7589
8130
7590
If this variable is set, mutt will try to use the "LAST" POP command for
7591
retrieving only unread messages from the POP server when using the fetch-mail
8131
If this variable is set, mutt will try to use the ?LAST? POP command for
8132
retrieving only unread messages from the POP server when using the <fetch-mail>
7592
8133
function.
7593
8134
7594
3.219. pop_reconnect
8135
3.220. pop_reconnect
7595
8136
7596
8137
Type: quadoption
7597
8138
Default: ask-yes
7598
8139
7599
Controls whether or not Mutt will try to reconnect to POP server if the
8140
Controls whether or not Mutt will try to reconnect to the POP server if the
7600
8141
connection is lost.
7601
8142
7602
3.220. pop_user
8143
3.221. pop_user
7603
8144
7604
8145
Type: string
7605
Default: ""
8146
Default: (empty)
7606
8147
7607
8148
Your login name on the POP server.
7608
8149
7609
8150
This variable defaults to your user name on the local machine.
7610
8151
7611
3.221. pop_pass
8152
3.222. pop_pass
7612
8153
7613
8154
Type: string
7614
Default: ""
8155
Default: (empty)
7615
8156
7616
8157
Specifies the password for your POP account. If unset, Mutt will prompt you for
7617
your password when you open POP mailbox. Warning: you should only use this
7618
option when you are on a fairly secure machine, because the superuser can read
7619
your muttrc even if you are the only one who can read the file.
7620
7621
3.222. post_indent_string
8158
your password when you open a POP mailbox.
8159
8160
Warning: you should only use this option when you are on a fairly secure
8161
machine, because the superuser can read your muttrc even if you are the only
8162
one who can read the file.
8163
8164
3.223. post_indent_string
7622
8165
7623
8166
Type: string
7624
Default: ""
7625
7626
Similar to the ``$attribution'' variable, Mutt will append this string after
7627
the inclusion of a message which is being replied to.
7628
7629
3.223. postpone
8167
Default: (empty)
8168
8169
Similar to the $attribution variable, Mutt will append this string after the
8170
inclusion of a message which is being replied to.
8171
8172
3.224. postpone
7630
8173
7631
8174
Type: quadoption
7632
8175
Default: ask-yes
7633
8176
7634
Controls whether or not messages are saved in the ``$postponed'' mailbox when
7635
you elect not to send immediately. Also see the ``$recall'' variable.
7636
7637
3.224. postponed
8177
Controls whether or not messages are saved in the $postponed mailbox when you
8178
elect not to send immediately.
8179
8180
Also see the $recall variable.
8181
8182
3.225. postponed
7638
8183
7639
8184
Type: path
7640
Default: "~/postponed"
8185
Default: ??/postponed?
7641
8186
7642
Mutt allows you to indefinitely ``postpone sending a message'' which you are
8187
Mutt allows you to indefinitely ?postpone sending a message? which you are
7643
8188
editing. When you choose to postpone a message, Mutt saves it in the mailbox
7644
specified by this variable. Also see the ``$postpone'' variable.
7645
7646
3.225. preconnect
8189
specified by this variable.
8190
8191
Also see the $postpone variable.
8192
8193
3.226. preconnect
7647
8194
7648
8195
Type: string
7649
Default: ""
8196
Default: (empty)
7650
8197
7651
8198
If set, a shell command to be executed if mutt fails to establish a connection
7652
8199
to the server. This is useful for setting up secure connections, e.g. with ssh
7653
8200
(1). If the command returns a nonzero status, mutt gives up opening the server.
7654
8201
Example:
7655
8202
7656
preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net sleep 20 < /dev/
7657
null > /dev/null"
7658
7659
Mailbox 'foo' on mailhost.net can now be reached as '{localhost:1234}foo'.
7660
7661
NOTE: For this example to work, you must be able to log in to the remote
8203
set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
8204
sleep 20 < /dev/null > /dev/null"
8205
8206
8207
Mailbox ?foo? on ?mailhost.net? can now be reached as ?{localhost:1234}foo?.
8208
8209
Note: For this example to work, you must be able to log in to the remote
7662
8210
machine without having to enter a password.
7663
8211
7664
3.226. print
8212
3.227. print
7665
8213
7666
8214
Type: quadoption
7667
8215
Default: ask-no
7668
8216
7669
Controls whether or not Mutt really prints messages. This is set to ask-no by
7670
default, because some people accidentally hit ``p'' often (like me).
8217
Controls whether or not Mutt really prints messages. This is set to ?ask-no? by
8218
default, because some people accidentally hit ?p? often.
7671
8219
7672
3.227. print_command
8220
3.228. print_command
7673
8221
7674
8222
Type: path
7675
Default: "lpr"
8223
Default: ?lpr?
7676
8224
7677
8225
This specifies the command pipe that should be used to print messages.
7678
8226
7679
3.228. print_decode
8227
3.229. print_decode
7680
8228
7681
8229
Type: boolean
7682
8230
Default: yes
7683
8231
7684
Used in connection with the print-message command. If this option is set, the
8232
Used in connection with the <print-message> command. If this option is set, the
7685
8233
message is decoded before it is passed to the external command specified by
7686
8234
$print_command. If this option is unset, no processing will be applied to the
7687
8235
message when printing it. The latter setting may be useful if you are using
7688
8236
some advanced printer filter which is able to properly format e-mail messages
7689
8237
for printing.
7690
8238
7691
3.229. print_split
8239
3.230. print_split
7692
8240
7693
8241
Type: boolean
7694
8242
Default: no
7695
8243
7696
Used in connection with the print-message command. If this option is set, the
8244
Used in connection with the <print-message> command. If this option is set, the
7697
8245
command specified by $print_command is executed once for each message which is
7698
8246
to be printed. If this option is unset, the command specified by $print_command
7699
8247
is executed only once, and all the messages are concatenated, with a form feed
7702
8250
Those who use the enscript(1) program's mail-printing mode will most likely
7703
8251
want to set this option.
7704
8252
7705
3.230. prompt_after
8253
3.231. prompt_after
7706
8254
7707
8255
Type: boolean
7708
8256
Default: yes
7709
8257
7710
If you use an external ``$pager'', setting this variable will cause Mutt to
7711
prompt you for a command when the pager exits rather than returning to the
7712
index menu. If unset, Mutt will return to the index menu when the external
7713
pager exits.
8258
If you use an external $pager, setting this variable will cause Mutt to prompt
8259
you for a command when the pager exits rather than returning to the index menu.
8260
If unset, Mutt will return to the index menu when the external pager exits.
7714
8261
7715
3.231. query_command
8262
3.232. query_command
7716
8263
7717
8264
Type: path
7718
Default: ""
8265
Default: (empty)
7719
8266
7720
8267
This specifies the command that mutt will use to make external address queries.
7721
The string should contain a %s, which will be substituted with the query string
7722
the user types. See ``query'' for more information.
8268
The string should contain a ?%s?, which will be substituted with the query
8269
string the user types. See ?query? for more information.
7723
8270
7724
3.232. query_format
8271
3.233. query_format
7725
8272
7726
8273
Type: string
7727
Default: "%4c %t %-25.25a %-25.25n %?e?(%e)?"
8274
Default: ?%4c %t %-25.25a %-25.25n %?e?(%e)??
7728
8275
7729
This variable describes the format of the `query' menu. The following
7730
printf-style sequences are understood:
8276
This variable describes the format of the ?query? menu. The following printf(3)
8277
-style sequences are understood:
7731
8278
7732
8279
%a
7733
8280
7747
8294
7748
8295
%t
7749
8296
7750
``*'' if current entry is tagged, a space otherwise
8297
?*? if current entry is tagged, a space otherwise
7751
8298
7752
8299
%>X
7753
8300
7754
right justify the rest of the string and pad with "X"
8301
right justify the rest of the string and pad with ?X?
7755
8302
7756
8303
%|X
7757
8304
7758
pad to the end of the line with "X"
8305
pad to the end of the line with ?X?
7759
8306
7760
8307
%*X
7761
8308
7762
soft-fill with character "X" as pad
7763
7764
For an explanation of `soft-fill', see the ``$index_format'' documentation.
7765
7766
* = can be optionally printed if nonzero, see the ``$status_format''
7767
documentation.
7768
7769
3.233. quit
8309
soft-fill with character ?X? as pad
8310
8311
For an explanation of ?soft-fill?, see the $index_format documentation.
8312
8313
* = can be optionally printed if nonzero, see the $status_format documentation.
8314
8315
3.234. quit
7770
8316
7771
8317
Type: quadoption
7772
8318
Default: yes
7773
8319
7774
This variable controls whether ``quit'' and ``exit'' actually quit from mutt.
7775
If it set to yes, they do quit, if it is set to no, they have no effect, and if
8320
This variable controls whether ?quit? and ?exit? actually quit from mutt. If
8321
this option is set, they do quit, if it is unset, they have no effect, and if
7776
8322
it is set to ask-yes or ask-no, you are prompted for confirmation when you try
7777
8323
to quit.
7778
8324
7779
3.234. quote_regexp
8325
3.235. quote_regexp
7780
8326
7781
8327
Type: regular expression
7782
Default: "^([ \t]*[|>:}#])+"
7783
7784
A regular expression used in the internal-pager to determine quoted sections of
7785
text in the body of a message.
7786
7787
Note: In order to use the quotedx patterns in the internal pager, you need to
7788
set this to a regular expression that matches exactly the quote characters at
7789
the beginning of quoted lines.
7790
7791
3.235. read_inc
8328
Default: ?^([ \t]*[|>:}#])+?
8329
8330
A regular expression used in the internal pager to determine quoted sections of
8331
text in the body of a message. Quoted text may be filtered out using the
8332
<toggle-quoted> command, or colored according to the ?color quoted? family of
8333
directives.
8334
8335
Higher levels of quoting may be colored differently (?color quoted1?, ?color
8336
quoted2?, etc.). The quoting level is determined by removing the last character
8337
from the matched text and recursively reapplying the regular expression until
8338
it fails to produce a match.
8339
8340
Match detection may be overridden by the $smileys regular expression.
8341
8342
3.236. read_inc
7792
8343
7793
8344
Type: number
7794
8345
Default: 10
7795
8346
7796
8347
If set to a value greater than 0, Mutt will display which message it is
7797
8348
currently on when reading a mailbox or when performing search actions such as
7798
search and limit. The message is printed after read_inc messages have been read
7799
or searched (e.g., if set to 25, Mutt will print a message when it is at
8349
search and limit. The message is printed after this many messages have been
8350
read or searched (e.g., if set to 25, Mutt will print a message when it is at
7800
8351
message 25, and then again when it gets to message 50). This variable is meant
7801
8352
to indicate progress when reading or searching large mailboxes which may take
7802
8353
some time. When set to 0, only a single message will appear before the reading
7803
8354
the mailbox.
7804
8355
7805
Also see the ``$write_inc'' variable and the ``Tuning'' section of the manual
7806
for performance considerations.
8356
Also see the $write_inc, $net_inc and $time_inc variables and the ?tuning?
8357
section of the manual for performance considerations.
7807
8358
7808
3.236. read_only
8359
3.237. read_only
7809
8360
7810
8361
Type: boolean
7811
8362
Default: no
7812
8363
7813
8364
If set, all folders are opened in read-only mode.
7814
8365
7815
3.237. realname
8366
3.238. realname
7816
8367
7817
8368
Type: string
7818
Default: ""
8369
Default: (empty)
7819
8370
7820
This variable specifies what "real" or "personal" name should be used when
8371
This variable specifies what ?real? or ?personal? name should be used when
7821
8372
sending messages.
7822
8373
7823
8374
By default, this is the GECOS field from /etc/passwd. Note that this variable
7824
8375
will not be used when the user has set a real name in the $from variable.
7825
8376
7826
3.238. recall
8377
3.239. recall
7827
8378
7828
8379
Type: quadoption
7829
8380
Default: ask-yes
7830
8381
7831
8382
Controls whether or not Mutt recalls postponed messages when composing a new
7832
message. Also see ``$postponed''.
7833
7834
Setting this variable to ``yes'' is not generally useful, and thus not
7835
recommended.
7836
7837
3.239. record
8383
message.
8384
8385
Setting this variable to is not generally useful, and thus not recommended.
8386
8387
Also see $postponed variable.
8388
8389
3.240. record
7838
8390
7839
8391
Type: path
7840
Default: "~/sent"
8392
Default: ??/sent?
7841
8393
7842
8394
This specifies the file into which your outgoing messages should be appended.
7843
8395
(This is meant as the primary method for saving a copy of your messages, but
7844
another way to do this is using the ``my_hdr'' command to create a Bcc: field
8396
another way to do this is using the ?my_hdr? command to create a ?Bcc:? field
7845
8397
with your email address in it.)
7846
8398
7847
The value of $record is overridden by the ``$force_name'' and ``$save_name''
7848
variables, and the ``fcc-hook'' command.
8399
The value of $record is overridden by the $force_name and $save_name variables,
8400
and the ?fcc-hook? command.
7849
8401
7850
3.240. reply_regexp
8402
3.241. reply_regexp
7851
8403
7852
8404
Type: regular expression
7853
Default: "^(re([\[0-9\]+])*|aw):[ \t]*"
8405
Default: ?^(re([\[0-9\]+])*|aw):[ \t]*?
7854
8406
7855
8407
A regular expression used to recognize reply messages when threading and
7856
8408
replying. The default value corresponds to the English "Re:" and the German
7857
8409
"Aw:".
7858
8410
7859
3.241. reply_self
8411
3.242. reply_self
7860
8412
7861
8413
Type: boolean
7862
8414
Default: no
7864
8416
If unset and you are replying to a message sent by you, Mutt will assume that
7865
8417
you want to reply to the recipients of that message rather than to yourself.
7866
8418
7867
3.242. reply_to
8419
Also see the ?alternates? command.
8420
8421
3.243. reply_to
7868
8422
7869
8423
Type: quadoption
7870
8424
Default: ask-yes
7875
8429
mailing list that sets the Reply-To: header field to the list address and you
7876
8430
want to send a private message to the author of a message.
7877
8431
7878
3.243. resolve
8432
3.244. resolve
7879
8433
7880
8434
Type: boolean
7881
8435
Default: yes
7884
8438
undeleted) message whenever a command that modifies the current message is
7885
8439
executed.
7886
8440
7887
3.244. reverse_alias
8441
3.245. reverse_alias
7888
8442
7889
8443
Type: boolean
7890
8444
Default: no
7891
8445
7892
This variable controls whether or not Mutt will display the "personal" name
8446
This variable controls whether or not Mutt will display the ?personal? name
7893
8447
from your aliases in the index menu if it finds an alias that matches the
7894
8448
message's sender. For example, if you have the following alias:
7895
8449
7901
8455
From: abd30425@somewhere.net
7902
8456
7903
8457
7904
It would be displayed in the index menu as ``Joe User'' instead of
7905
``abd30425@somewhere.net.'' This is useful when the person's e-mail address is
7906
not human friendly (like CompuServe addresses).
8458
It would be displayed in the index menu as ?Joe User? instead of
8459
?abd30425@somewhere.net.? This is useful when the person's e-mail address is
8460
not human friendly.
7907
8461
7908
3.245. reverse_name
8462
3.246. reverse_name
7909
8463
7910
8464
Type: boolean
7911
8465
Default: no
7914
8468
messages to another machine, and reply to some the messages from there. If this
7915
8469
variable is set, the default From: line of the reply messages is built using
7916
8470
the address where you received the messages you are replying to if that address
7917
matches your alternates. If the variable is unset, or the address that would be
7918
used doesn't match your alternates, the From: line will use your address on the
7919
current machine.
7920
7921
3.246. reverse_realname
8471
matches your ?alternates?. If the variable is unset, or the address that would
8472
be used doesn't match your ?alternates?, the From: line will use your address
8473
on the current machine.
8474
8475
Also see the ?alternates? command.
8476
8477
3.247. reverse_realname
7922
8478
7923
8479
Type: boolean
7924
8480
Default: yes
7925
8481
7926
This variable fine-tunes the behaviour of the reverse_name feature. When it is
8482
This variable fine-tunes the behaviour of the $reverse_name feature. When it is
7927
8483
set, mutt will use the address from incoming messages as-is, possibly including
7928
8484
eventual real names. When it is unset, mutt will override any such real names
7929
with the setting of the realname variable.
8485
with the setting of the $realname variable.
7930
8486
7931
3.247. rfc2047_parameters
8487
3.248. rfc2047_parameters
7932
8488
7933
8489
Type: boolean
7934
8490
Default: no
7935
8491
7936
When this variable is set, Mutt will decode RFC-2047-encoded MIME parameters.
8492
When this variable is set, Mutt will decode RFC2047-encoded MIME parameters.
7937
8493
You want to set this variable when mutt suggests you to save attachments to
7938
files named like this: =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
7939
7940
When this variable is set interactively, the change doesn't have the desired
7941
effect before you have changed folders.
7942
7943
Note that this use of RFC 2047's encoding is explicitly, prohibited by the
7944
standard, but nevertheless encountered in the wild. Also note that setting this
7945
parameter will not have the effect that mutt generates this kind of encoding.
7946
Instead, mutt will unconditionally use the encoding specified in RFC 2231.
7947
7948
3.248. save_address
8494
files named like:
8495
8496
=?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
8497
8498
8499
When this variable is set interactively, the change won't be active until you
8500
change folders.
8501
8502
Note that this use of RFC2047's encoding is explicitly prohibited by the
8503
standard, but nevertheless encountered in the wild.
8504
8505
Also note that setting this parameter will not have the effect that mutt
8506
generates this kind of encoding. Instead, mutt will unconditionally use the
8507
encoding specified in RFC2231.
8508
8509
3.249. save_address
7949
8510
7950
8511
Type: boolean
7951
8512
Default: no
7952
8513
7953
8514
If set, mutt will take the sender's full address when choosing a default folder
7954
for saving a mail. If ``$save_name'' or ``$force_name'' is set too, the
7955
selection of the fcc folder will be changed as well.
8515
for saving a mail. If $save_name or $force_name is set too, the selection of
8516
the Fcc folder will be changed as well.
7956
8517
7957
3.249. save_empty
8518
3.250. save_empty
7958
8519
7959
8520
Type: boolean
7960
8521
Default: yes
7961
8522
7962
8523
When unset, mailboxes which contain no saved messages will be removed when
7963
closed (the exception is ``$spoolfile'' which is never removed). If set,
7964
mailboxes are never removed.
8524
closed (the exception is $spoolfile which is never removed). If set, mailboxes
8525
are never removed.
7965
8526
7966
8527
Note: This only applies to mbox and MMDF folders, Mutt does not delete MH and
7967
8528
Maildir directories.
7968
8529
7969
3.250. save_history
8530
3.251. save_history
7970
8531
7971
8532
Type: number
7972
8533
Default: 0
7973
8534
7974
This variable controls the size of the history saved in the ``$history_file''
7975
file.
8535
This variable controls the size of the history (per category) saved in the
8536
$history_file file.
7976
8537
7977
3.251. save_name
8538
3.252. save_name
7978
8539
7979
8540
Type: boolean
7980
8541
Default: no
7981
8542
7982
8543
This variable controls how copies of outgoing messages are saved. When set, a
7983
8544
check is made to see if a mailbox specified by the recipient address exists
7984
(this is done by searching for a mailbox in the ``$folder'' directory with the
8545
(this is done by searching for a mailbox in the $folder directory with the
7985
8546
username part of the recipient address). If the mailbox exists, the outgoing
7986
message will be saved to that mailbox, otherwise the message is saved to the ``
7987
$record'' mailbox.
7988
7989
Also see the ``$force_name'' variable.
7990
7991
3.252. score
8547
message will be saved to that mailbox, otherwise the message is saved to the
8548
$record mailbox.
8549
8550
Also see the $force_name variable.
8551
8552
3.253. score
7992
8553
7993
8554
Type: boolean
7994
8555
Default: yes
7995
8556
7996
8557
When this variable is unset, scoring is turned off. This can be useful to
7997
selectively disable scoring for certain folders when the ``
7998
$score_threshold_delete'' variable and friends are used.
8558
selectively disable scoring for certain folders when the
8559
$score_threshold_delete variable and related are used.
7999
8560
8000
3.253. score_threshold_delete
8561
3.254. score_threshold_delete
8001
8562
8002
8563
Type: number
8003
8564
Default: -1
8007
8568
are always greater than or equal to zero, the default setting of this variable
8008
8569
will never mark a message for deletion.
8009
8570
8010
3.254. score_threshold_flag
8571
3.255. score_threshold_flag
8011
8572
8012
8573
Type: number
8013
8574
Default: 9999
8015
8576
Messages which have been assigned a score greater than or equal to this
8016
8577
variable's value are automatically marked "flagged".
8017
8578
8018
3.255. score_threshold_read
8579
3.256. score_threshold_read
8019
8580
8020
8581
Type: number
8021
8582
Default: -1
8025
8586
always greater than or equal to zero, the default setting of this variable will
8026
8587
never mark a message read.
8027
8588
8028
3.256. send_charset
8589
3.257. send_charset
8029
8590
8030
8591
Type: string
8031
Default: "us-ascii:iso-8859-1:utf-8"
8592
Default: ?us-ascii:iso-8859-1:utf-8?
8032
8593
8033
8594
A colon-delimited list of character sets for outgoing messages. Mutt will use
8034
8595
the first character set into which the text can be converted exactly. If your
8035
``$charset'' is not iso-8859-1 and recipients may not understand UTF-8, it is
8596
$charset is not ?iso-8859-1? and recipients may not understand ?UTF-8?, it is
8036
8597
advisable to include in the list an appropriate widely used standard character
8037
set (such as iso-8859-2, koi8-r or iso-2022-jp) either instead of or after
8038
"iso-8859-1".
8039
8040
In case the text cannot be converted into one of these exactly, mutt uses ``
8041
$charset'' as a fallback.
8042
8043
3.257. sendmail
8598
set (such as ?iso-8859-2?, ?koi8-r? or ?iso-2022-jp?) either instead of or
8599
after ?iso-8859-1?.
8600
8601
In case the text cannot be converted into one of these exactly, mutt uses
8602
$charset as a fallback.
8603
8604
3.258. sendmail
8044
8605
8045
8606
Type: path
8046
Default: "/usr/sbin/sendmail -oem -oi"
8607
Default: ?/usr/sbin/sendmail -oem -oi?
8047
8608
8048
8609
Specifies the program and arguments used to deliver mail sent by Mutt. Mutt
8049
8610
expects that the specified program interprets additional arguments as recipient
8050
8611
addresses.
8051
8612
8052
3.258. sendmail_wait
8613
3.259. sendmail_wait
8053
8614
8054
8615
Type: number
8055
8616
Default: 0
8056
8617
8057
Specifies the number of seconds to wait for the ``$sendmail'' process to finish
8618
Specifies the number of seconds to wait for the $sendmail process to finish
8058
8619
before giving up and putting delivery in the background.
8059
8620
8060
8621
Mutt interprets the value of this variable as follows:
8075
8636
will be put in a temporary file. If there is some error, you will be informed
8076
8637
as to where to find the output.
8077
8638
8078
3.259. shell
8639
3.260. shell
8079
8640
8080
8641
Type: path
8081
Default: ""
8642
Default: (empty)
8082
8643
8083
8644
Command to use when spawning a subshell. By default, the user's login shell
8084
8645
from /etc/passwd is used.
8085
8646
8086
3.260. sig_dashes
8647
3.261. sig_dashes
8087
8648
8088
8649
Type: boolean
8089
8650
Default: yes
8090
8651
8091
If set, a line containing ``-- '' will be inserted before your ``$signature''.
8092
It is strongly recommended that you not unset this variable unless your
8093
``signature'' contains just your name. The reason for this is because many
8094
software packages use ``-- \n'' to detect your signature. For example, Mutt has
8095
the ability to highlight the signature in a different color in the builtin
8096
pager.
8652
If set, a line containing ?-- ? (note the trailing space) will be inserted
8653
before your $signature. It is strongly recommended that you not unset this
8654
variable unless your signature contains just your name. The reason for this is
8655
because many software packages use ?-- \n? to detect your signature. For
8656
example, Mutt has the ability to highlight the signature in a different color
8657
in the builtin pager.
8097
8658
8098
3.261. sig_on_top
8659
3.262. sig_on_top
8099
8660
8100
8661
Type: boolean
8101
8662
Default: no
8105
8666
know what you are doing, and are prepared to take some heat from netiquette
8106
8667
guardians.
8107
8668
8108
3.262. signature
8669
3.263. signature
8109
8670
8110
8671
Type: path
8111
Default: "~/.signature"
8672
Default: ??/.signature?
8112
8673
8113
8674
Specifies the filename of your signature, which is appended to all outgoing
8114
messages. If the filename ends with a pipe (``|''), it is assumed that filename
8115
is a shell command and input should be read from its stdout.
8675
messages. If the filename ends with a pipe (?|?), it is assumed that filename
8676
is a shell command and input should be read from its standard output.
8116
8677
8117
3.263. simple_search
8678
3.264. simple_search
8118
8679
8119
8680
Type: string
8120
Default: "~f %s | ~s %s"
8681
Default: ??f %s | ?s %s?
8121
8682
8122
8683
Specifies how Mutt should expand a simple search into a real search pattern. A
8123
simple search is one that does not contain any of the ~ operators. See ``
8124
patterns'' for more information on search patterns.
8125
8126
For example, if you simply type joe at a search or limit prompt, Mutt will
8127
automatically expand it to the value specified by this variable. For the
8128
default value it would be:
8129
8130
~f joe | ~s joe
8131
8132
3.264. smart_wrap
8684
simple search is one that does not contain any of the ??? pattern operators.
8685
See ?patterns? for more information on search patterns.
8686
8687
For example, if you simply type ?joe? at a search or limit prompt, Mutt will
8688
automatically expand it to the value specified by this variable by replacing
8689
?%s? with the supplied string. For the default value, ?joe? would be expanded
8690
to: ??f joe | ?s joe?.
8691
8692
3.265. smart_wrap
8133
8693
8134
8694
Type: boolean
8135
8695
Default: yes
8136
8696
8137
8697
Controls the display of lines longer than the screen width in the internal
8138
8698
pager. If set, long lines are wrapped at a word boundary. If unset, lines are
8139
simply wrapped at the screen edge. Also see the ``$markers'' variable.
8699
simply wrapped at the screen edge. Also see the $markers variable.
8140
8700
8141
3.265. smileys
8701
3.266. smileys
8142
8702
8143
8703
Type: regular expression
8144
Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
8145
8146
The pager uses this variable to catch some common false positives of ``
8147
$quote_regexp'', most notably smileys in the beginning of a line
8148
8149
3.266. sleep_time
8704
Default: ?(>From )|(:[-^]?[][)(><}{|/DP])?
8705
8706
The pager uses this variable to catch some common false positives of
8707
$quote_regexp, most notably smileys and not consider a line quoted text if it
8708
also matches $smileys. This mostly happens at the beginning of a line.
8709
8710
3.267. sleep_time
8150
8711
8151
8712
Type: number
8152
8713
Default: 1
8156
8717
the current folder. The default is to pause one second, so a value of zero for
8157
8718
this option suppresses the pause.
8158
8719
8159
3.267. smtp_authenticators
8720
3.268. smtp_authenticators
8160
8721
8161
8722
Type: string
8162
Default: ""
8723
Default: (empty)
8163
8724
8164
8725
This is a colon-delimited list of authentication methods mutt may attempt to
8165
8726
use to log in to an SMTP server, in the order mutt should try them.
8166
Authentication methods are any SASL mechanism, eg ``digest-md5'', ``gssapi'' or
8167
``cram-md5''. This parameter is case-insensitive. If this parameter is unset
8168
(the default) mutt will try all available methods, in order from most-secure to
8169
least-secure.
8170
8171
Example: set smtp_authenticators="digest-md5:cram-md5"
8172
8173
3.268. smtp_pass
8727
Authentication methods are any SASL mechanism, eg ?digest-md5?, ?gssapi? or
8728
?cram-md5?. This option is case-insensitive. If it is ?unset? (the default)
8729
mutt will try all available methods, in order from most-secure to least-secure.
8730
8731
Example:
8732
8733
set smtp_authenticators="digest-md5:cram-md5"
8734
8735
8736
3.269. smtp_pass
8174
8737
8175
8738
Type: string
8176
Default: ""
8739
Default: (empty)
8177
8740
8178
8741
Specifies the password for your SMTP account. If unset, Mutt will prompt you
8179
for your password when you first send mail via SMTP. See ``smtp_url'' to
8180
configure mutt to send mail via SMTP. Warning: you should only use this option
8181
when you are on a fairly secure machine, because the superuser can read your
8182
muttrc even if you are the only one who can read the file.
8183
8184
3.269. smtp_url
8742
for your password when you first send mail via SMTP. See $smtp_url to configure
8743
mutt to send mail via SMTP.
8744
8745
Warning: you should only use this option when you are on a fairly secure
8746
machine, because the superuser can read your muttrc even if you are the only
8747
one who can read the file.
8748
8749
3.270. smtp_url
8185
8750
8186
8751
Type: string
8187
Default: ""
8752
Default: (empty)
8188
8753
8189
Defines the SMTP ``smart'' host where sent messages should relayed for
8190
delivery. This should take the form of an SMTP URL, eg:
8754
Defines the SMTP smarthost where sent messages should relayed for delivery.
8755
This should take the form of an SMTP URL, eg:
8191
8756
8192
8757
smtp[s]://[user[:pass]@]host[:port]/
8193
8758
8194
Setting this variable overrides the value of the ``$sendmail'' variable.
8195
8196
3.270. sort
8759
8760
... where ?[...]? denotes an optional part. Setting this variable overrides the
8761
value of the $sendmail variable.
8762
8763
3.271. sort
8197
8764
8198
8765
Type: sort order
8199
8766
Default: date
8200
8767
8201
Specifies how to sort messages in the index menu. Valid values are:
8202
8203
date or date-sent
8204
date-received
8205
from
8206
mailbox-order (unsorted)
8207
score
8208
size
8209
spam
8210
subject
8211
threads
8212
to
8213
8214
8215
You may optionally use the reverse- prefix to specify reverse sorting order
8216
(example: set sort=reverse-date-sent).
8217
8218
3.271. sort_alias
8768
Specifies how to sort messages in the ?index? menu. Valid values are:
8769
8770
* date or date-sent
8771
8772
* date-received
8773
8774
* from
8775
8776
* mailbox-order (unsorted)
8777
8778
* score
8779
8780
* size
8781
8782
* spam
8783
8784
* subject
8785
8786
* threads
8787
8788
* to
8789
8790
You may optionally use the ?reverse-? prefix to specify reverse sorting order
8791
(example: ?set sort=reverse-date-sent?).
8792
8793
3.272. sort_alias
8219
8794
8220
8795
Type: sort order
8221
8796
Default: alias
8222
8797
8223
Specifies how the entries in the `alias' menu are sorted. The following are
8798
Specifies how the entries in the ?alias? menu are sorted. The following are
8224
8799
legal values:
8225
8800
8226
address (sort alphabetically by email address)
8227
alias (sort alphabetically by alias name)
8228
unsorted (leave in order specified in .muttrc)
8229
8230
8231
3.272. sort_aux
8801
* address (sort alphabetically by email address)
8802
8803
* alias (sort alphabetically by alias name)
8804
8805
* unsorted (leave in order specified in .muttrc)
8806
8807
3.273. sort_aux
8232
8808
8233
8809
Type: sort order
8234
8810
Default: date
8235
8811
8236
8812
When sorting by threads, this variable controls how threads are sorted in
8237
8813
relation to other threads, and how the branches of the thread trees are sorted.
8238
This can be set to any value that ``$sort'' can, except threads (in that case,
8239
mutt will just use date-sent). You can also specify the last- prefix in
8240
addition to the reverse- prefix, but last- must come after reverse-. The last-
8241
prefix causes messages to be sorted against its siblings by which has the last
8242
descendant, using the rest of sort_aux as an ordering. For instance, set
8243
sort_aux=last- date-received would mean that if a new message is received in a
8244
thread, that thread becomes the last one displayed (or the first, if you have
8245
set sort=reverse-threads.) Note: For reversed ``$sort'' order $sort_aux is
8246
reversed again (which is not the right thing to do, but kept to not break any
8247
existing configuration setting).
8248
8249
3.273. sort_browser
8814
This can be set to any value that $sort can, except ?threads? (in that case,
8815
mutt will just use ?date-sent?). You can also specify the ?last-? prefix in
8816
addition to the ?reverse-? prefix, but ?last-? must come after ?reverse-?. The
8817
?last-? prefix causes messages to be sorted against its siblings by which has
8818
the last descendant, using the rest of $sort_aux as an ordering. For instance,
8819
8820
set sort_aux=last-date-received
8821
8822
8823
would mean that if a new message is received in a thread, that thread becomes
8824
the last one displayed (or the first, if you have ?set sort=reverse-threads?.)
8825
8826
Note: For reversed $sort order $sort_aux is reversed again (which is not the
8827
right thing to do, but kept to not break any existing configuration setting).
8828
8829
3.274. sort_browser
8250
8830
8251
8831
Type: sort order
8252
8832
Default: alpha
8254
8834
Specifies how to sort entries in the file browser. By default, the entries are
8255
8835
sorted alphabetically. Valid values:
8256
8836
8257
alpha (alphabetically)
8258
date
8259
size
8260
unsorted
8261
8262
8263
You may optionally use the reverse- prefix to specify reverse sorting order
8264
(example: set sort_browser=reverse-date).
8265
8266
3.274. sort_re
8837
* alpha (alphabetically)
8838
8839
* date
8840
8841
* size
8842
8843
* unsorted
8844
8845
You may optionally use the ?reverse-? prefix to specify reverse sorting order
8846
(example: ?set sort_browser=reverse-date?).
8847
8848
3.275. sort_re
8267
8849
8268
8850
Type: boolean
8269
8851
Default: yes
8270
8852
8271
This variable is only useful when sorting by threads with ``$strict_threads''
8272
unset. In that case, it changes the heuristic mutt uses to thread messages by
8273
subject. With sort_re set, mutt will only attach a message as the child of
8853
This variable is only useful when sorting by threads with $strict_threads unset
8854
. In that case, it changes the heuristic mutt uses to thread messages by
8855
subject. With $sort_re set, mutt will only attach a message as the child of
8274
8856
another message by subject if the subject of the child message starts with a
8275
substring matching the setting of ``$reply_regexp''. With sort_re unset, mutt
8276
will attach the message whether or not this is the case, as long as the non-``
8277
$reply_regexp'' parts of both messages are identical.
8857
substring matching the setting of $reply_regexp. With $sort_re unset, mutt will
8858
attach the message whether or not this is the case, as long as the non-
8859
$reply_regexp parts of both messages are identical.
8278
8860
8279
3.275. spam_separator
8861
3.276. spam_separator
8280
8862
8281
8863
Type: string
8282
Default: ","
8283
8284
``spam_separator'' controls what happens when multiple spam headers are
8285
matched: if unset, each successive header will overwrite any previous matches
8286
value for the spam label. If set, each successive match will append to the
8287
previous, using ``spam_separator'' as a separator.
8288
8289
3.276. spoolfile
8864
Default: ?,?
8865
8866
This variable controls what happens when multiple spam headers are matched: if
8867
unset, each successive header will overwrite any previous matches value for the
8868
spam label. If set, each successive match will append to the previous, using
8869
this variable's value as a separator.
8870
8871
3.277. spoolfile
8290
8872
8291
8873
Type: path
8292
Default: ""
8874
Default: (empty)
8293
8875
8294
8876
If your spool mailbox is in a non-default place where Mutt cannot find it, you
8295
8877
can specify its location with this variable. Mutt will automatically set this
8296
8878
variable to the value of the environment variable $MAIL if it is not set.
8297
8879
8298
3.277. status_chars
8880
3.278. status_chars
8299
8881
8300
8882
Type: string
8301
Default: "-*%A"
8883
Default: ?-*%A?
8302
8884
8303
Controls the characters used by the "%r" indicator in ``$status_format''. The
8304
first character is used when the mailbox is unchanged. The second is used when
8305
the mailbox has been changed, and it needs to be resynchronized. The third is
8306
used if the mailbox is in read-only mode, or if the mailbox will not be written
8307
when exiting that mailbox (You can toggle whether to write changes to a mailbox
8308
with the toggle-write operation, bound by default to "%"). The fourth is used
8309
to indicate that the current folder has been opened in attach- message mode
8885
Controls the characters used by the ?%r? indicator in $status_format. The first
8886
character is used when the mailbox is unchanged. The second is used when the
8887
mailbox has been changed, and it needs to be resynchronized. The third is used
8888
if the mailbox is in read-only mode, or if the mailbox will not be written when
8889
exiting that mailbox (You can toggle whether to write changes to a mailbox with
8890
the <toggle-write> operation, bound by default to ?%?). The fourth is used to
8891
indicate that the current folder has been opened in attach- message mode
8310
8892
(Certain operations like composing a new mail, replying, forwarding, etc. are
8311
8893
not permitted in this mode).
8312
8894
8313
3.278. status_format
8895
3.279. status_format
8314
8896
8315
8897
Type: string
8316
Default: "-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F?
8317
Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---"
8898
Default: ?-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F?
8899
Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---?
8318
8900
8319
Controls the format of the status line displayed in the index menu. This string
8320
is similar to ``$index_format'', but has its own set of printf()-like
8901
Controls the format of the status line displayed in the ?index? menu. This
8902
string is similar to $index_format, but has its own set of printf(3)-like
8321
8903
sequences:
8322
8904
8323
8905
%b
8404
8986
8405
8987
%>X
8406
8988
8407
right justify the rest of the string and pad with "X"
8989
right justify the rest of the string and pad with ?X?
8408
8990
8409
8991
%|X
8410
8992
8411
pad to the end of the line with "X"
8993
pad to the end of the line with ?X?
8412
8994
8413
8995
%*X
8414
8996
8415
soft-fill with character "X" as pad
8997
soft-fill with character ?X? as pad
8416
8998
8417
For an explanation of `soft-fill', see the ``$index_format'' documentation.
8999
For an explanation of ?soft-fill?, see the $index_format documentation.
8418
9000
8419
9001
* = can be optionally printed if nonzero
8420
9002
8432
9014
optional strings.
8433
9015
8434
9016
Here is an example illustrating how to optionally print the number of new
8435
messages in a mailbox: %?n?%n new messages.?
9017
messages in a mailbox:
9018
9019
%?n?%n new messages.?
8436
9020
8437
9021
You can also switch between two strings using the following construct:
8438
9022
8441
9025
If the value of sequence_char is non-zero, if_string will be expanded,
8442
9026
otherwise else_string will be expanded.
8443
9027
8444
You can force the result of any printf-like sequence to be lowercase by
8445
prefixing the sequence character with an underscore (_) sign. For example, if
8446
you want to display the local hostname in lowercase, you would use: %_h
9028
You can force the result of any printf(3)-like sequence to be lowercase by
9029
prefixing the sequence character with an underscore (?_?) sign. For example, if
9030
you want to display the local hostname in lowercase, you would use: ?%_h?.
8447
9031
8448
If you prefix the sequence character with a colon (:) character, mutt will
9032
If you prefix the sequence character with a colon (?:?) character, mutt will
8449
9033
replace any dots in the expansion by underscores. This might be helpful with
8450
9034
IMAP folders that don't like dots in folder names.
8451
9035
8452
3.279. status_on_top
8453
8454
Type: boolean
8455
Default: no
8456
8457
Setting this variable causes the ``status bar'' to be displayed on the first
8458
line of the screen rather than near the bottom.
8459
8460
3.280. strict_threads
8461
8462
Type: boolean
8463
Default: no
8464
8465
If set, threading will only make use of the ``In-Reply-To'' and ``References''
8466
fields when you ``$sort'' by message threads. By default, messages with the
8467
same subject are grouped together in ``pseudo threads.''. This may not always
8468
be desirable, such as in a personal mailbox where you might have several
8469
unrelated messages with the subject ``hi'' which will get grouped together. See
8470
also ``$sort_re'' for a less drastic way of controlling this behaviour.
8471
8472
3.281. suspend
9036
3.280. status_on_top
9037
9038
Type: boolean
9039
Default: no
9040
9041
Setting this variable causes the ?status bar? to be displayed on the first line
9042
of the screen rather than near the bottom. If $help is set, too it'll be placed
9043
at the bottom.
9044
9045
3.281. strict_threads
9046
9047
Type: boolean
9048
Default: no
9049
9050
If set, threading will only make use of the ?In-Reply-To? and ?References:?
9051
fields when you $sort by message threads. By default, messages with the same
9052
subject are grouped together in ?pseudo threads.?. This may not always be
9053
desirable, such as in a personal mailbox where you might have several unrelated
9054
messages with the subjects like ?hi? which will get grouped together. See also
9055
$sort_re for a less drastic way of controlling this behaviour.
9056
9057
3.282. suspend
8473
9058
8474
9059
Type: boolean
8475
9060
Default: yes
8476
9061
8477
9062
When unset, mutt won't stop when the user presses the terminal's susp key,
8478
usually ``control-Z''. This is useful if you run mutt inside an xterm using a
8479
command like xterm -e mutt.
9063
usually ?^Z?. This is useful if you run mutt inside an xterm using a command
9064
like ?xterm -e mutt?.
8480
9065
8481
3.282. text_flowed
9066
3.283. text_flowed
8482
9067
8483
9068
Type: boolean
8484
9069
Default: no
8485
9070
8486
When set, mutt will generate text/plain; format=flowed attachments. This format
8487
is easier to handle for some mailing software, and generally just looks like
8488
ordinary text. To actually make use of this format's features, you'll need
8489
support in your editor.
9071
When set, mutt will generate ?format=flowed? bodies with a content type of
9072
?text/plain; format=flowed?. This format is easier to handle for some mailing
9073
software, and generally just looks like ordinary text. To actually make use of
9074
this format's features, you'll need support in your editor.
8490
9075
8491
9076
Note that $indent_string is ignored when this option is set.
8492
9077
8493
3.283. thread_received
9078
3.284. thread_received
8494
9079
8495
9080
Type: boolean
8496
9081
Default: no
8498
9083
When set, mutt uses the date received rather than the date sent to thread
8499
9084
messages by subject.
8500
9085
8501
3.284. thorough_search
9086
3.285. thorough_search
8502
9087
8503
9088
Type: boolean
8504
9089
Default: no
8505
9090
8506
Affects the ~b and ~h search operations described in section ``patterns''
8507
above. If set, the headers and attachments of messages to be searched are
8508
decoded before searching. If unset, messages are searched as they appear in the
8509
folder.
8510
8511
3.285. tilde
9091
Affects the ?b and ?h search operations described in section ?patterns?. If set
9092
, the headers and body/attachments of messages to be searched are decoded
9093
before searching. If unset, messages are searched as they appear in the folder.
9094
9095
Users searching attachments or for non-ASCII characters should set this value
9096
because decoding also includes MIME parsing/decoding and possible character set
9097
conversions. Otherwise mutt will attempt to match against the raw message
9098
received (for example quoted-printable encoded or with encoded headers) which
9099
may lead to incorrect search results.
9100
9101
3.286. tilde
8512
9102
8513
9103
Type: boolean
8514
9104
Default: no
8515
9105
8516
9106
When set, the internal-pager will pad blank lines to the bottom of the screen
8517
with a tilde (~).
9107
with a tilde (???).
8518
9108
8519
3.286. time_inc
9109
3.287. time_inc
8520
9110
8521
9111
Type: number
8522
9112
Default: 0
8523
9113
8524
Along with ``read_inc'', ``write_inc'', and ``net_inc'', this variable controls
8525
the frequency with which progress updates are displayed. It suppresses updates
8526
less than ``time_inc'' milliseconds apart. This can improve throughput on
8527
systems with slow terminals, or when running mutt on a remote system.
8528
8529
3.287. timeout
9114
Along with $read_inc, $write_inc, and $net_inc, this variable controls the
9115
frequency with which progress updates are displayed. It suppresses updates less
9116
than $time_inc milliseconds apart. This can improve throughput on systems with
9117
slow terminals, or when running mutt on a remote system.
9118
9119
Also see the ?tuning? section of the manual for performance considerations.
9120
9121
3.288. timeout
8530
9122
8531
9123
Type: number
8532
9124
Default: 600
8541
9133
8542
9134
A value of zero or less will cause Mutt to never time out.
8543
9135
8544
3.288. tmpdir
9136
3.289. tmpdir
8545
9137
8546
9138
Type: path
8547
Default: ""
9139
Default: (empty)
8548
9140
8549
9141
This variable allows you to specify where Mutt will place its temporary files
8550
9142
needed for displaying and composing messages. If this variable is not set, the
8551
environment variable TMPDIR is used. If TMPDIR is not set then "/tmp" is used.
9143
environment variable $TMPDIR is used. If $TMPDIR is not set then ?/tmp? is
9144
used.
8552
9145
8553
3.289. to_chars
9146
3.290. to_chars
8554
9147
8555
9148
Type: string
8556
Default: " +TCFL"
9149
Default: ? +TCFL?
8557
9150
8558
9151
Controls the character used to indicate mail addressed to you. The first
8559
character is the one used when the mail is NOT addressed to your address
8560
(default: space). The second is used when you are the only recipient of the
8561
message (default: +). The third is when your address appears in the TO header
8562
field, but you are not the only recipient of the message (default: T). The
8563
fourth character is used when your address is specified in the CC header field,
8564
but you are not the only recipient. The fifth character is used to indicate
8565
mail that was sent by you. The sixth character is used to indicate when a mail
8566
was sent to a mailing-list you subscribe to (default: L).
9152
character is the one used when the mail is not addressed to your address. The
9153
second is used when you are the only recipient of the message. The third is
9154
when your address appears in the ?To:? header field, but you are not the only
9155
recipient of the message. The fourth character is used when your address is
9156
specified in the ?Cc:? header field, but you are not the only recipient. The
9157
fifth character is used to indicate mail that was sent by you. The sixth
9158
character is used to indicate when a mail was sent to a mailing-list you
9159
subscribe to.
8567
9160
8568
3.290. tunnel
9161
3.291. tunnel
8569
9162
8570
9163
Type: string
8571
Default: ""
9164
Default: (empty)
8572
9165
8573
9166
Setting this variable will cause mutt to open a pipe to a command instead of a
8574
9167
raw socket. You may be able to use this to set up preauthenticated connections
8575
to your IMAP/POP3 server. Example:
8576
8577
tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
8578
8579
NOTE: For this example to work you must be able to log in to the remote machine
9168
to your IMAP/POP3/SMTP server. Example:
9169
9170
set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
9171
9172
9173
Note: For this example to work you must be able to log in to the remote machine
8580
9174
without having to enter a password.
8581
9175
8582
3.291. use_8bitmime
9176
3.292. use_8bitmime
8583
9177
8584
9178
Type: boolean
8585
9179
Default: no
8588
9182
which supports the -B8BITMIME flag (such as sendmail 8.8.x) or you may not be
8589
9183
able to send mail.
8590
9184
8591
When set, Mutt will invoke ``$sendmail'' with the -B8BITMIME flag when sending
9185
When set, Mutt will invoke $sendmail with the -B8BITMIME flag when sending
8592
9186
8-bit messages to enable ESMTP negotiation.
8593
9187
8594
3.292. use_domain
9188
3.293. use_domain
8595
9189
8596
9190
Type: boolean
8597
9191
Default: yes
8598
9192
8599
When set, Mutt will qualify all local addresses (ones without the @host
8600
portion) with the value of ``$hostname''. If unset, no addresses will be
8601
qualified.
9193
When set, Mutt will qualify all local addresses (ones without the ?@host?
9194
portion) with the value of $hostname. If unset, no addresses will be qualified.
8602
9195
8603
3.293. use_envelope_from
9196
3.294. use_envelope_from
8604
9197
8605
9198
Type: boolean
8606
9199
Default: no
8607
9200
8608
When set, mutt will set the envelope sender of the message. If ``
8609
$envelope_from_address'' is set, it will be used as the sender address. If not,
8610
mutt will attempt to derive the sender from the "From:" header.
8611
8612
Note that this information is passed to sendmail command using the "-f" command
8613
line switch. Therefore setting this option is not useful if the ``$sendmail''
8614
variable already contains "-f" or if the executable pointed to by $sendmail
8615
doesn't support the "-f" switch.
8616
8617
3.294. use_from
9201
When set, mutt will set the envelope sender of the message. If
9202
$envelope_from_address is set, it will be used as the sender address. If unset,
9203
mutt will attempt to derive the sender from the ?From:? header.
9204
9205
Note that this information is passed to sendmail command using the -f command
9206
line switch. Therefore setting this option is not useful if the $sendmail
9207
variable already contains -f or if the executable pointed to by $sendmail
9208
doesn't support the -f switch.
9209
9210
3.295. use_from
8618
9211
8619
9212
Type: boolean
8620
9213
Default: yes
8621
9214
8622
When set, Mutt will generate the `From:' header field when sending messages. If
8623
unset, no `From:' header field will be generated unless the user explicitly
8624
sets one using the ``my_hdr'' command.
9215
When set, Mutt will generate the ?From:? header field when sending messages. If
9216
unset, no ?From:? header field will be generated unless the user explicitly
9217
sets one using the ?my_hdr? command.
8625
9218
8626
3.295. use_idn
9219
3.296. use_idn
8627
9220
8628
9221
Type: boolean
8629
9222
Default: yes
8632
9225
use IDNs for addresses even if this is unset. This variable only affects
8633
9226
decoding.
8634
9227
8635
3.296. use_ipv6
9228
3.297. use_ipv6
8636
9229
8637
9230
Type: boolean
8638
9231
Default: yes
8641
9234
this option is unset, Mutt will restrict itself to IPv4 addresses. Normally,
8642
9235
the default should work.
8643
9236
8644
3.297. user_agent
9237
3.298. user_agent
8645
9238
8646
9239
Type: boolean
8647
9240
Default: yes
8648
9241
8649
When set, mutt will add a "User-Agent" header to outgoing messages, indicating
9242
When set, mutt will add a ?User-Agent:? header to outgoing messages, indicating
8650
9243
which version of mutt was used for composing them.
8651
9244
8652
3.298. visual
9245
3.299. visual
8653
9246
8654
9247
Type: path
8655
Default: ""
9248
Default: (empty)
8656
9249
8657
Specifies the visual editor to invoke when the ~v command is given in the
9250
Specifies the visual editor to invoke when the ??v? command is given in the
8658
9251
builtin editor.
8659
9252
8660
3.299. wait_key
9253
3.300. wait_key
8661
9254
8662
9255
Type: boolean
8663
9256
Default: yes
8664
9257
8665
Controls whether Mutt will ask you to press a key after shell- escape,
8666
pipe-message, pipe-entry, print-message, and print-entry commands.
9258
Controls whether Mutt will ask you to press a key after an external command has
9259
been invoked by these functions: <shell-escape>, <pipe-message>, <pipe-entry>,
9260
<print-message>, and <print-entry> commands.
8667
9261
8668
It is also used when viewing attachments with ``auto_view'', provided that the
9262
It is also used when viewing attachments with ?auto_view?, provided that the
8669
9263
corresponding mailcap entry has a needsterminal flag, and the external program
8670
9264
is interactive.
8671
9265
8672
9266
When set, Mutt will always ask for a key. When unset, Mutt will wait for a key
8673
9267
only if the external command returned a non-zero status.
8674
9268
8675
3.300. weed
9269
3.301. weed
8676
9270
8677
9271
Type: boolean
8678
9272
Default: yes
8680
9274
When set, mutt will weed headers when displaying, forwarding, printing, or
8681
9275
replying to messages.
8682
9276
8683
3.301. wrap
9277
3.302. wrap
8684
9278
8685
9279
Type: number
8686
9280
Default: 0
8689
9283
to a negative value, mutt will wrap text so that there are $wrap characters of
8690
9284
empty space on the right side of the terminal.
8691
9285
8692
3.302. wrap_search
9286
3.303. wrap_search
8693
9287
8694
9288
Type: boolean
8695
9289
Default: yes
8696
9290
8697
Controls whether searches wrap around the end of the mailbox.
8698
8699
When set, searches will wrap around the first (or last) message. When unset,
8700
searches will not wrap.
8701
8702
3.303. wrapmargin
9291
Controls whether searches wrap around the end.
9292
9293
When set, searches will wrap around the first (or last) item. When unset,
9294
incremental searches will not wrap.
9295
9296
3.304. wrapmargin
8703
9297
8704
9298
Type: number
8705
9299
Default: 0
8706
9300
8707
(DEPRECATED) Equivalent to setting wrap with a negative value.
9301
(DEPRECATED) Equivalent to setting $wrap with a negative value.
8708
9302
8709
3.304. write_inc
9303
3.305. write_inc
8710
9304
8711
9305
Type: number
8712
9306
Default: 10
8713
9307
8714
When writing a mailbox, a message will be printed every write_inc messages to
9308
When writing a mailbox, a message will be printed every $write_inc messages to
8715
9309
indicate progress. If set to 0, only a single message will be displayed before
8716
9310
writing a mailbox.
8717
9311
8718
Also see the ``$read_inc'' variable.
9312
Also see the $read_inc, $net_inc and $time_inc variables and the ?tuning?
9313
section of the manual for performance considerations.
8719
9314
8720
3.305. write_bcc
9315
3.306. write_bcc
8721
9316
8722
9317
Type: boolean
8723
9318
Default: yes
8724
9319
8725
Controls whether mutt writes out the Bcc header when preparing messages to be
8726
sent. Exim users may wish to unset this. If mutt is set to deliver directly via
8727
SMTP (see ``$smtp_url''), this option does nothing: mutt will never write out
8728
the BCC header in this case.
9320
Controls whether mutt writes out the ?Bcc:? header when preparing messages to
9321
be sent. Exim users may wish to unset this. If mutt is set to deliver directly
9322
via SMTP (see $smtp_url), this option does nothing: mutt will never write out
9323
the ?Bcc:? header in this case.
8729
9324
8730
9325
4. Functions
8731
9326
8734
9329
what the function does. The key bindings of these functions can be changed with
8735
9330
the bind command.
8736
9331
8737
4.1. generic
9332
4.1. generic menu
8738
9333
8739
9334
The generic menu is not a real menu, but specifies common functions (such as
8740
9335
movement) available in all menus except for pager and editor. Changing settings
8742
9337
8743
9338
Table 8.2. Default generic function bindings
8744
9339
8745
┌───────────────┬───────────┬───────────────────────────────────────────┐
8746
│ Function │Default key│ Description │
8747
├───────────────┼───────────┼───────────────────────────────────────────┤
8748
│top-page │H │move to the top of the page │
8749
├───────────────┼───────────┼───────────────────────────────────────────┤
8750
│next-entry │j │move to the next entry │
8751
├───────────────┼───────────┼───────────────────────────────────────────┤
8752
│previous-entry │k │move to the previous entry │
8753
├───────────────┼───────────┼───────────────────────────────────────────┤
8754
│bottom-page │L │move to the bottom of the page │
8755
├───────────────┼───────────┼───────────────────────────────────────────┤
8756
│refresh │^L │clear and redraw the screen │
8757
├───────────────┼───────────┼───────────────────────────────────────────┤
8758
│middle-page │M │move to the middle of the page │
8759
├───────────────┼───────────┼───────────────────────────────────────────┤
8760
│search-next │n │search for next match │
8761
├───────────────┼───────────┼───────────────────────────────────────────┤
8762
│exit │q │exit this menu │
8763
├───────────────┼───────────┼───────────────────────────────────────────┤
8764
│tag-entry │t │tag the current entry │
8765
├───────────────┼───────────┼───────────────────────────────────────────┤
8766
│next-page │z │move to the next page │
8767
├───────────────┼───────────┼───────────────────────────────────────────┤
8768
│previous-page │Z │move to the previous page │
8769
├───────────────┼───────────┼───────────────────────────────────────────┤
8770
│last-entry │* │move to the last entry │
8771
├───────────────┼───────────┼───────────────────────────────────────────┤
8772
│first-entry │= │move to the first entry │
8773
├───────────────┼───────────┼───────────────────────────────────────────┤
8774
│enter-command │: │enter a muttrc command │
8775
├───────────────┼───────────┼───────────────────────────────────────────┤
8776
│next-line │> │scroll down one line │
8777
├───────────────┼───────────┼───────────────────────────────────────────┤
8778
│previous-line │< │scroll up one line │
8779
├───────────────┼───────────┼───────────────────────────────────────────┤
8780
│half-up │[ │scroll up 1/2 page │
8781
├───────────────┼───────────┼───────────────────────────────────────────┤
8782
│half-down │] │scroll down 1/2 page │
8783
├───────────────┼───────────┼───────────────────────────────────────────┤
8784
│help │? │this screen │
8785
├───────────────┼───────────┼───────────────────────────────────────────┤
8786
│tag-prefix │; │apply next function to tagged messages │
8787
├───────────────┼───────────┼───────────────────────────────────────────┤
8788
│tag-prefix-cond│not bound │apply next function ONLY to tagged messages│
8789
├───────────────┼───────────┼───────────────────────────────────────────┤
8790
│end-cond │not bound │end of conditional execution (noop) │
8791
├───────────────┼───────────┼───────────────────────────────────────────┤
8792
│shell-escape │! │invoke a command in a subshell │
8793
├───────────────┼───────────┼───────────────────────────────────────────┤
8794
│select-entry │RET │select the current entry │
8795
├───────────────┼───────────┼───────────────────────────────────────────┤
8796
│search │/ │search for a regular expression │
8797
├───────────────┼───────────┼───────────────────────────────────────────┤
8798
│search-reverse │ESC / │search backwards for a regular expression │
8799
├───────────────┼───────────┼───────────────────────────────────────────┤
8800
│search-opposite│not bound │search for next match in opposite direction│
8801
├───────────────┼───────────┼───────────────────────────────────────────┤
8802
│jump │not bound │jump to an index number │
8803
├───────────────┼───────────┼───────────────────────────────────────────┤
8804
│current-top │not bound │move entry to top of screen │
8805
├───────────────┼───────────┼───────────────────────────────────────────┤
8806
│current-middle │not bound │move entry to middle of screen │
8807
├───────────────┼───────────┼───────────────────────────────────────────┤
8808
│current-bottom │not bound │move entry to bottom of screen │
8809
├───────────────┼───────────┼───────────────────────────────────────────┤
8810
│what-key │not bound │display the keycode for a key press │
8811
└───────────────┴───────────┴───────────────────────────────────────────┘
8812
8813
8814
4.2. index
9340
+-------------------------------------------------------------------------+
9341
| Function |Default key| Description |
9342
|-----------------+-----------+-------------------------------------------|
9343
|<top-page> |H |move to the top of the page |
9344
|-----------------+-----------+-------------------------------------------|
9345
|<next-entry> |j |move to the next entry |
9346
|-----------------+-----------+-------------------------------------------|
9347
|<previous-entry> |k |move to the previous entry |
9348
|-----------------+-----------+-------------------------------------------|
9349
|<bottom-page> |L |move to the bottom of the page |
9350
|-----------------+-----------+-------------------------------------------|
9351
|<refresh> |^L |clear and redraw the screen |
9352
|-----------------+-----------+-------------------------------------------|
9353
|<middle-page> |M |move to the middle of the page |
9354
|-----------------+-----------+-------------------------------------------|
9355
|<search-next> |n |search for next match |
9356
|-----------------+-----------+-------------------------------------------|
9357
|<exit> |q |exit this menu |
9358
|-----------------+-----------+-------------------------------------------|
9359
|<tag-entry> |t |tag the current entry |
9360
|-----------------+-----------+-------------------------------------------|
9361
|<next-page> |z |move to the next page |
9362
|-----------------+-----------+-------------------------------------------|
9363
|<previous-page> |Z |move to the previous page |
9364
|-----------------+-----------+-------------------------------------------|
9365
|<last-entry> |* |move to the last entry |
9366
|-----------------+-----------+-------------------------------------------|
9367
|<first-entry> |= |move to the first entry |
9368
|-----------------+-----------+-------------------------------------------|
9369
|<enter-command> |: |enter a muttrc command |
9370
|-----------------+-----------+-------------------------------------------|
9371
|<next-line> |> |scroll down one line |
9372
|-----------------+-----------+-------------------------------------------|
9373
|<previous-line> |< |scroll up one line |
9374
|-----------------+-----------+-------------------------------------------|
9375
|<half-up> |[ |scroll up 1/2 page |
9376
|-----------------+-----------+-------------------------------------------|
9377
|<half-down> |] |scroll down 1/2 page |
9378
|-----------------+-----------+-------------------------------------------|
9379
|<help> |? |this screen |
9380
|-----------------+-----------+-------------------------------------------|
9381
|<tag-prefix> |; |apply next function to tagged messages |
9382
|-----------------+-----------+-------------------------------------------|
9383
|<tag-prefix-cond>| |apply next function ONLY to tagged messages|
9384
|-----------------+-----------+-------------------------------------------|
9385
|<end-cond> | |end of conditional execution (noop) |
9386
|-----------------+-----------+-------------------------------------------|
9387
|<shell-escape> |! |invoke a command in a subshell |
9388
|-----------------+-----------+-------------------------------------------|
9389
|<select-entry> |<Return> |select the current entry |
9390
|-----------------+-----------+-------------------------------------------|
9391
|<search> |/ |search for a regular expression |
9392
|-----------------+-----------+-------------------------------------------|
9393
|<search-reverse> |Esc / |search backwards for a regular expression |
9394
|-----------------+-----------+-------------------------------------------|
9395
|<search-opposite>| |search for next match in opposite direction|
9396
|-----------------+-----------+-------------------------------------------|
9397
|<jump> | |jump to an index number |
9398
|-----------------+-----------+-------------------------------------------|
9399
|<current-top> | |move entry to top of screen |
9400
|-----------------+-----------+-------------------------------------------|
9401
|<current-middle> | |move entry to middle of screen |
9402
|-----------------+-----------+-------------------------------------------|
9403
|<current-bottom> | |move entry to bottom of screen |
9404
|-----------------+-----------+-------------------------------------------|
9405
|<what-key> | |display the keycode for a key press |
9406
+-------------------------------------------------------------------------+
9407
9408
9409
4.2. index menu
8815
9410
8816
9411
Table 8.3. Default index function bindings
8817
9412
8818
┌────────────────────────┬─────────┬──────────────────────────────────────────┐
8819
│ Function │ Default │ Description │
8820
│ │ key │ │
8821
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8822
│create-alias │a │create an alias from a message sender │
8823
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8824
│bounce-message │b │remail a message to another user │
8825
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8826
│break-thread │# │break the thread in two │
8827
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8828
│change-folder │c │open a different folder │
8829
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8830
│change-folder-readonly │ESC c │open a different folder in read only mode │
8831
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8832
│next-unread-mailbox │not bound│open next mailbox with new mail │
8833
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8834
│collapse-thread │ESC v │collapse/uncollapse current thread │
8835
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8836
│collapse-all │ESC V │collapse/uncollapse all threads │
8837
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8838
│copy-message │C │copy a message to a file/mailbox │
8839
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8840
│decode-copy │ESC C │make decoded (text/plain) copy │
8841
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8842
│decode-save │ESC s │make decoded copy (text/plain) and delete │
8843
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8844
│delete-message │d │delete the current entry │
8845
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8846
│delete-pattern │D │delete messages matching a pattern │
8847
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8848
│delete-thread │^D │delete all messages in thread │
8849
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8850
│delete-subthread │ESC d │delete all messages in subthread │
8851
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8852
│edit │e │edit the raw message │
8853
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8854
│edit-type │^E │edit attachment content type │
8855
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8856
│forward-message │f │forward a message with comments │
8857
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8858
│flag-message │F │toggle a message's 'important' flag │
8859
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8860
│group-reply │g │reply to all recipients │
8861
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8862
│fetch-mail │G │retrieve mail from POP server │
8863
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8864
│imap-fetch-mail │not bound│force retrieval of mail from IMAP server │
8865
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8866
│display-toggle-weed │h │display message and toggle header weeding │
8867
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8868
│next-undeleted │j │move to the next undeleted message │
8869
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8870
│previous-undeleted │k │move to the previous undeleted message │
8871
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8872
│limit │l │show only messages matching a pattern │
8873
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8874
│link-threads │& │link tagged message to the current one │
8875
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8876
│list-reply │L │reply to specified mailing list │
8877
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8878
│mail │m │compose a new mail message │
8879
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8880
│toggle-new │N │toggle a message's 'new' flag │
8881
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8882
│toggle-write │% │toggle whether the mailbox will be │
8883
│ │ │rewritten │
8884
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8885
│next-thread │^N │jump to the next thread │
8886
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8887
│next-subthread │ESC n │jump to the next subthread │
8888
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8889
│query │Q │query external program for addresses │
8890
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8891
│quit │q │save changes to mailbox and quit │
8892
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8893
│reply │r │reply to a message │
8894
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8895
│show-limit │ESC l │show currently active limit pattern │
8896
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8897
│sort-mailbox │o │sort messages │
8898
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8899
│sort-reverse │O │sort messages in reverse order │
8900
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8901
│print-message │p │print the current entry │
8902
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8903
│previous-thread │^P │jump to previous thread │
8904
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8905
│previous-subthread │ESC p │jump to previous subthread │
8906
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8907
│recall-message │R │recall a postponed message │
8908
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8909
│read-thread │^R │mark the current thread as read │
8910
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8911
│read-subthread │ESC r │mark the current subthread as read │
8912
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8913
│resend-message │ESC e │use the current message as a template for │
8914
│ │ │a new one │
8915
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8916
│save-message │s │save message/attachment to a file │
8917
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8918
│tag-pattern │T │tag messages matching a pattern │
8919
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8920
│tag-subthread │not bound│tag the current subthread │
8921
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8922
│tag-thread │ESC t │tag the current thread │
8923
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8924
│untag-pattern │^T │untag messages matching a pattern │
8925
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8926
│undelete-message │u │undelete the current entry │
8927
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8928
│undelete-pattern │U │undelete messages matching a pattern │
8929
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8930
│undelete-subthread │ESC u │undelete all messages in subthread │
8931
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8932
│undelete-thread │^U │undelete all messages in thread │
8933
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8934
│view-attachments │v │show MIME attachments │
8935
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8936
│show-version │V │show the Mutt version number and date │
8937
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8938
│set-flag │w │set a status flag on a message │
8939
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8940
│clear-flag │W │clear a status flag from a message │
8941
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8942
│display-message │RET │display a message │
8943
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8944
│buffy-list │. │list mailboxes with new mail │
8945
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8946
│sync-mailbox │$ │save changes to mailbox │
8947
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8948
│display-address │@ │display full address of sender │
8949
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8950
│pipe-message │| │pipe message/attachment to a shell command│
8951
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8952
│next-new │not bound│jump to the next new message │
8953
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8954
│next-new-then-unread │TAB │jump to the next new or unread message │
8955
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8956
│previous-new │not bound│jump to the previous new message │
8957
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8958
│previous-new-then-unread│ESC TAB │jump to the previous new or unread message│
8959
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8960
│next-unread │not bound│jump to the next unread message │
8961
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8962
│previous-unread │not bound│jump to the previous unread message │
8963
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8964
│parent-message │P │jump to parent message in thread │
8965
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8966
│extract-keys │^K │extract supported public keys │
8967
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8968
│forget-passphrase │^F │wipe passphrase(s) from memory │
8969
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8970
│check-traditional-pgp │ESC P │check for classic PGP │
8971
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8972
│mail-key │ESC k │mail a PGP public key │
8973
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8974
│decrypt-copy │not bound│make decrypted copy │
8975
├────────────────────────┼─────────┼──────────────────────────────────────────┤
8976
│decrypt-save │not bound│make decrypted copy and delete │
8977
└────────────────────────┴─────────┴──────────────────────────────────────────┘
8978
8979
8980
4.3. pager
9413
+-----------------------------------------------------------------------------+
9414
| Function | Default | Description |
9415
| | key | |
9416
|--------------------------+---------+----------------------------------------|
9417
|<create-alias> |a |create an alias from a message sender |
9418
|--------------------------+---------+----------------------------------------|
9419
|<bounce-message> |b |remail a message to another user |
9420
|--------------------------+---------+----------------------------------------|
9421
|<break-thread> |# |break the thread in two |
9422
|--------------------------+---------+----------------------------------------|
9423
|<change-folder> |c |open a different folder |
9424
|--------------------------+---------+----------------------------------------|
9425
|<change-folder-readonly> |Esc c |open a different folder in read only |
9426
| | |mode |
9427
|--------------------------+---------+----------------------------------------|
9428
|<next-unread-mailbox> | |open next mailbox with new mail |
9429
|--------------------------+---------+----------------------------------------|
9430
|<collapse-thread> |Esc v |collapse/uncollapse current thread |
9431
|--------------------------+---------+----------------------------------------|
9432
|<collapse-all> |Esc V |collapse/uncollapse all threads |
9433
|--------------------------+---------+----------------------------------------|
9434
|<copy-message> |C |copy a message to a file/mailbox |
9435
|--------------------------+---------+----------------------------------------|
9436
|<decode-copy> |Esc C |make decoded (text/plain) copy |
9437
|--------------------------+---------+----------------------------------------|
9438
|<decode-save> |Esc s |make decoded copy (text/plain) and |
9439
| | |delete |
9440
|--------------------------+---------+----------------------------------------|
9441
|<delete-message> |d |delete the current entry |
9442
|--------------------------+---------+----------------------------------------|
9443
|<delete-pattern> |D |delete messages matching a pattern |
9444
|--------------------------+---------+----------------------------------------|
9445
|<delete-thread> |^D |delete all messages in thread |
9446
|--------------------------+---------+----------------------------------------|
9447
|<delete-subthread> |Esc d |delete all messages in subthread |
9448
|--------------------------+---------+----------------------------------------|
9449
|<edit> |e |edit the raw message |
9450
|--------------------------+---------+----------------------------------------|
9451
|<edit-type> |^E |edit attachment content type |
9452
|--------------------------+---------+----------------------------------------|
9453
|<forward-message> |f |forward a message with comments |
9454
|--------------------------+---------+----------------------------------------|
9455
|<flag-message> |F |toggle a message's 'important' flag |
9456
|--------------------------+---------+----------------------------------------|
9457
|<group-reply> |g |reply to all recipients |
9458
|--------------------------+---------+----------------------------------------|
9459
|<fetch-mail> |G |retrieve mail from POP server |
9460
|--------------------------+---------+----------------------------------------|
9461
|<imap-fetch-mail> | |force retrieval of mail from IMAP server|
9462
|--------------------------+---------+----------------------------------------|
9463
|<display-toggle-weed> |h |display message and toggle header |
9464
| | |weeding |
9465
|--------------------------+---------+----------------------------------------|
9466
|<next-undeleted> |j |move to the next undeleted message |
9467
|--------------------------+---------+----------------------------------------|
9468
|<previous-undeleted> |k |move to the previous undeleted message |
9469
|--------------------------+---------+----------------------------------------|
9470
|<limit> |l |show only messages matching a pattern |
9471
|--------------------------+---------+----------------------------------------|
9472
|<link-threads> |& |link tagged message to the current one |
9473
|--------------------------+---------+----------------------------------------|
9474
|<list-reply> |L |reply to specified mailing list |
9475
|--------------------------+---------+----------------------------------------|
9476
|<mail> |m |compose a new mail message |
9477
|--------------------------+---------+----------------------------------------|
9478
|<toggle-new> |N |toggle a message's 'new' flag |
9479
|--------------------------+---------+----------------------------------------|
9480
|<toggle-write> |% |toggle whether the mailbox will be |
9481
| | |rewritten |
9482
|--------------------------+---------+----------------------------------------|
9483
|<next-thread> |^N |jump to the next thread |
9484
|--------------------------+---------+----------------------------------------|
9485
|<next-subthread> |Esc n |jump to the next subthread |
9486
|--------------------------+---------+----------------------------------------|
9487
|<query> |Q |query external program for addresses |
9488
|--------------------------+---------+----------------------------------------|
9489
|<quit> |q |save changes to mailbox and quit |
9490
|--------------------------+---------+----------------------------------------|
9491
|<reply> |r |reply to a message |
9492
|--------------------------+---------+----------------------------------------|
9493
|<show-limit> |Esc l |show currently active limit pattern |
9494
|--------------------------+---------+----------------------------------------|
9495
|<sort-mailbox> |o |sort messages |
9496
|--------------------------+---------+----------------------------------------|
9497
|<sort-reverse> |O |sort messages in reverse order |
9498
|--------------------------+---------+----------------------------------------|
9499
|<print-message> |p |print the current entry |
9500
|--------------------------+---------+----------------------------------------|
9501
|<previous-thread> |^P |jump to previous thread |
9502
|--------------------------+---------+----------------------------------------|
9503
|<previous-subthread> |Esc p |jump to previous subthread |
9504
|--------------------------+---------+----------------------------------------|
9505
|<recall-message> |R |recall a postponed message |
9506
|--------------------------+---------+----------------------------------------|
9507
|<read-thread> |^R |mark the current thread as read |
9508
|--------------------------+---------+----------------------------------------|
9509
|<read-subthread> |Esc r |mark the current subthread as read |
9510
|--------------------------+---------+----------------------------------------|
9511
|<resend-message> |Esc e |use the current message as a template |
9512
| | |for a new one |
9513
|--------------------------+---------+----------------------------------------|
9514
|<save-message> |s |save message/attachment to a file |
9515
|--------------------------+---------+----------------------------------------|
9516
|<tag-pattern> |T |tag messages matching a pattern |
9517
|--------------------------+---------+----------------------------------------|
9518
|<tag-subthread> | |tag the current subthread |
9519
|--------------------------+---------+----------------------------------------|
9520
|<tag-thread> |Esc t |tag the current thread |
9521
|--------------------------+---------+----------------------------------------|
9522
|<untag-pattern> |^T |untag messages matching a pattern |
9523
|--------------------------+---------+----------------------------------------|
9524
|<undelete-message> |u |undelete the current entry |
9525
|--------------------------+---------+----------------------------------------|
9526
|<undelete-pattern> |U |undelete messages matching a pattern |
9527
|--------------------------+---------+----------------------------------------|
9528
|<undelete-subthread> |Esc u |undelete all messages in subthread |
9529
|--------------------------+---------+----------------------------------------|
9530
|<undelete-thread> |^U |undelete all messages in thread |
9531
|--------------------------+---------+----------------------------------------|
9532
|<view-attachments> |v |show MIME attachments |
9533
|--------------------------+---------+----------------------------------------|
9534
|<show-version> |V |show the Mutt version number and date |
9535
|--------------------------+---------+----------------------------------------|
9536
|<set-flag> |w |set a status flag on a message |
9537
|--------------------------+---------+----------------------------------------|
9538
|<clear-flag> |W |clear a status flag from a message |
9539
|--------------------------+---------+----------------------------------------|
9540
|<display-message> |<Return> |display a message |
9541
|--------------------------+---------+----------------------------------------|
9542
|<buffy-list> |. |list mailboxes with new mail |
9543
|--------------------------+---------+----------------------------------------|
9544
|<sync-mailbox> |$ |save changes to mailbox |
9545
|--------------------------+---------+----------------------------------------|
9546
|<display-address> |@ |display full address of sender |
9547
|--------------------------+---------+----------------------------------------|
9548
|<pipe-message> || |pipe message/attachment to a shell |
9549
| | |command |
9550
|--------------------------+---------+----------------------------------------|
9551
|<next-new> | |jump to the next new message |
9552
|--------------------------+---------+----------------------------------------|
9553
|<next-new-then-unread> |<Tab> |jump to the next new or unread message |
9554
|--------------------------+---------+----------------------------------------|
9555
|<previous-new> | |jump to the previous new message |
9556
|--------------------------+---------+----------------------------------------|
9557
|<previous-new-then-unread>|Esc <Tab>|jump to the previous new or unread |
9558
| | |message |
9559
|--------------------------+---------+----------------------------------------|
9560
|<next-unread> | |jump to the next unread message |
9561
|--------------------------+---------+----------------------------------------|
9562
|<previous-unread> | |jump to the previous unread message |
9563
|--------------------------+---------+----------------------------------------|
9564
|<parent-message> |P |jump to parent message in thread |
9565
|--------------------------+---------+----------------------------------------|
9566
|<extract-keys> |^K |extract supported public keys |
9567
|--------------------------+---------+----------------------------------------|
9568
|<forget-passphrase> |^F |wipe passphrase(s) from memory |
9569
|--------------------------+---------+----------------------------------------|
9570
|<check-traditional-pgp> |Esc P |check for classic PGP |
9571
|--------------------------+---------+----------------------------------------|
9572
|<mail-key> |Esc k |mail a PGP public key |
9573
|--------------------------+---------+----------------------------------------|
9574
|<decrypt-copy> | |make decrypted copy |
9575
|--------------------------+---------+----------------------------------------|
9576
|<decrypt-save> | |make decrypted copy and delete |
9577
+-----------------------------------------------------------------------------+
9578
9579
9580
4.3. pager menu
8981
9581
8982
9582
Table 8.4. Default pager function bindings
8983
9583
8984
┌──────────────────────┬─────────┬────────────────────────────────────────────┐
8985
│ Function │ Default │ Description │
8986
│ │ key │ │
8987
├──────────────────────┼─────────┼────────────────────────────────────────────┤
8988
│break-thread │# │break the thread in two │
8989
├──────────────────────┼─────────┼────────────────────────────────────────────┤
8990
│create-alias │a │create an alias from a message sender │
8991
├──────────────────────┼─────────┼────────────────────────────────────────────┤
8992
│bounce-message │b │remail a message to another user │
8993
├──────────────────────┼─────────┼────────────────────────────────────────────┤
8994
│change-folder │c │open a different folder │
8995
├──────────────────────┼─────────┼────────────────────────────────────────────┤
8996
│change-folder-readonly│ESC c │open a different folder in read only mode │
8997
├──────────────────────┼─────────┼────────────────────────────────────────────┤
8998
│next-unread-mailbox │not bound│open next mailbox with new mail │
8999
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9000
│copy-message │C │copy a message to a file/mailbox │
9001
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9002
│decode-copy │ESC C │make decoded (text/plain) copy │
9003
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9004
│delete-message │d │delete the current entry │
9005
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9006
│delete-thread │^D │delete all messages in thread │
9007
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9008
│delete-subthread │ESC d │delete all messages in subthread │
9009
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9010
│edit │e │edit the raw message │
9011
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9012
│edit-type │^E │edit attachment content type │
9013
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9014
│forward-message │f │forward a message with comments │
9015
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9016
│flag-message │F │toggle a message's 'important' flag │
9017
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9018
│group-reply │g │reply to all recipients │
9019
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9020
│imap-fetch-mail │not bound│force retrieval of mail from IMAP server │
9021
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9022
│display-toggle-weed │h │display message and toggle header weeding │
9023
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9024
│next-undeleted │j │move to the next undeleted message │
9025
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9026
│next-entry │J │move to the next entry │
9027
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9028
│previous-undeleted │k │move to the previous undeleted message │
9029
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9030
│previous-entry │K │move to the previous entry │
9031
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9032
│link-threads │& │link tagged message to the current one │
9033
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9034
│list-reply │L │reply to specified mailing list │
9035
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9036
│redraw-screen │^L │clear and redraw the screen │
9037
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9038
│mail │m │compose a new mail message │
9039
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9040
│mark-as-new │N │toggle a message's 'new' flag │
9041
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9042
│search-next │n │search for next match │
9043
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9044
│next-thread │^N │jump to the next thread │
9045
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9046
│next-subthread │ESC n │jump to the next subthread │
9047
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9048
│print-message │p │print the current entry │
9049
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9050
│previous-thread │^P │jump to previous thread │
9051
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9052
│previous-subthread │ESC p │jump to previous subthread │
9053
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9054
│quit │Q │save changes to mailbox and quit │
9055
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9056
│exit │q │exit this menu │
9057
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9058
│reply │r │reply to a message │
9059
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9060
│recall-message │R │recall a postponed message │
9061
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9062
│read-thread │^R │mark the current thread as read │
9063
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9064
│read-subthread │ESC r │mark the current subthread as read │
9065
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9066
│resend-message │ESC e │use the current message as a template for a │
9067
│ │ │new one │
9068
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9069
│save-message │s │save message/attachment to a file │
9070
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9071
│skip-quoted │S │skip beyond quoted text │
9072
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9073
│decode-save │ESC s │make decoded copy (text/plain) and delete │
9074
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9075
│tag-message │t │tag the current entry │
9076
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9077
│toggle-quoted │T │toggle display of quoted text │
9078
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9079
│undelete-message │u │undelete the current entry │
9080
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9081
│undelete-subthread │ESC u │undelete all messages in subthread │
9082
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9083
│undelete-thread │^U │undelete all messages in thread │
9084
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9085
│view-attachments │v │show MIME attachments │
9086
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9087
│show-version │V │show the Mutt version number and date │
9088
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9089
│search-toggle │\\ │toggle search pattern coloring │
9090
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9091
│display-address │@ │display full address of sender │
9092
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9093
│next-new │not bound│jump to the next new message │
9094
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9095
│pipe-message │| │pipe message/attachment to a shell command │
9096
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9097
│help │? │this screen │
9098
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9099
│next-page │Space │move to the next page │
9100
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9101
│previous-page │- │move to the previous page │
9102
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9103
│top │^ │jump to the top of the message │
9104
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9105
│sync-mailbox │$ │save changes to mailbox │
9106
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9107
│shell-escape │! │invoke a command in a subshell │
9108
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9109
│enter-command │: │enter a muttrc command │
9110
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9111
│buffy-list │. │list mailboxes with new mail │
9112
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9113
│search │/ │search for a regular expression │
9114
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9115
│search-reverse │ESC / │search backwards for a regular expression │
9116
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9117
│search-opposite │not bound│search for next match in opposite direction │
9118
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9119
│next-line │RET │scroll down one line │
9120
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9121
│jump │not bound│jump to an index number │
9122
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9123
│next-unread │not bound│jump to the next unread message │
9124
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9125
│previous-new │not bound│jump to the previous new message │
9126
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9127
│previous-unread │not bound│jump to the previous unread message │
9128
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9129
│half-up │not bound│scroll up 1/2 page │
9130
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9131
│half-down │not bound│scroll down 1/2 page │
9132
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9133
│previous-line │not bound│scroll up one line │
9134
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9135
│bottom │not bound│jump to the bottom of the message │
9136
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9137
│parent-message │P │jump to parent message in thread │
9138
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9139
│check-traditional-pgp │ESC P │check for classic PGP │
9140
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9141
│mail-key │ESC k │mail a PGP public key │
9142
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9143
│extract-keys │^K │extract supported public keys │
9144
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9145
│forget-passphrase │^F │wipe passphrase(s) from memory │
9146
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9147
│decrypt-copy │not bound│make decrypted copy │
9148
├──────────────────────┼─────────┼────────────────────────────────────────────┤
9149
│decrypt-save │not bound│make decrypted copy and delete │
9150
└──────────────────────┴─────────┴────────────────────────────────────────────┘
9151
9152
9153
4.4. alias
9584
+-----------------------------------------------------------------------------+
9585
| Function | Default | Description |
9586
| | key | |
9587
|------------------------+---------+------------------------------------------|
9588
|<break-thread> |# |break the thread in two |
9589
|------------------------+---------+------------------------------------------|
9590
|<create-alias> |a |create an alias from a message sender |
9591
|------------------------+---------+------------------------------------------|
9592
|<bounce-message> |b |remail a message to another user |
9593
|------------------------+---------+------------------------------------------|
9594
|<change-folder> |c |open a different folder |
9595
|------------------------+---------+------------------------------------------|
9596
|<change-folder-readonly>|Esc c |open a different folder in read only mode |
9597
|------------------------+---------+------------------------------------------|
9598
|<next-unread-mailbox> | |open next mailbox with new mail |
9599
|------------------------+---------+------------------------------------------|
9600
|<copy-message> |C |copy a message to a file/mailbox |
9601
|------------------------+---------+------------------------------------------|
9602
|<decode-copy> |Esc C |make decoded (text/plain) copy |
9603
|------------------------+---------+------------------------------------------|
9604
|<delete-message> |d |delete the current entry |
9605
|------------------------+---------+------------------------------------------|
9606
|<delete-thread> |^D |delete all messages in thread |
9607
|------------------------+---------+------------------------------------------|
9608
|<delete-subthread> |Esc d |delete all messages in subthread |
9609
|------------------------+---------+------------------------------------------|
9610
|<edit> |e |edit the raw message |
9611
|------------------------+---------+------------------------------------------|
9612
|<edit-type> |^E |edit attachment content type |
9613
|------------------------+---------+------------------------------------------|
9614
|<forward-message> |f |forward a message with comments |
9615
|------------------------+---------+------------------------------------------|
9616
|<flag-message> |F |toggle a message's 'important' flag |
9617
|------------------------+---------+------------------------------------------|
9618
|<group-reply> |g |reply to all recipients |
9619
|------------------------+---------+------------------------------------------|
9620
|<imap-fetch-mail> | |force retrieval of mail from IMAP server |
9621
|------------------------+---------+------------------------------------------|
9622
|<display-toggle-weed> |h |display message and toggle header weeding |
9623
|------------------------+---------+------------------------------------------|
9624
|<next-undeleted> |j |move to the next undeleted message |
9625
|------------------------+---------+------------------------------------------|
9626
|<next-entry> |J |move to the next entry |
9627
|------------------------+---------+------------------------------------------|
9628
|<previous-undeleted> |k |move to the previous undeleted message |
9629
|------------------------+---------+------------------------------------------|
9630
|<previous-entry> |K |move to the previous entry |
9631
|------------------------+---------+------------------------------------------|
9632
|<link-threads> |& |link tagged message to the current one |
9633
|------------------------+---------+------------------------------------------|
9634
|<list-reply> |L |reply to specified mailing list |
9635
|------------------------+---------+------------------------------------------|
9636
|<redraw-screen> |^L |clear and redraw the screen |
9637
|------------------------+---------+------------------------------------------|
9638
|<mail> |m |compose a new mail message |
9639
|------------------------+---------+------------------------------------------|
9640
|<mark-as-new> |N |toggle a message's 'new' flag |
9641
|------------------------+---------+------------------------------------------|
9642
|<search-next> |n |search for next match |
9643
|------------------------+---------+------------------------------------------|
9644
|<next-thread> |^N |jump to the next thread |
9645
|------------------------+---------+------------------------------------------|
9646
|<next-subthread> |Esc n |jump to the next subthread |
9647
|------------------------+---------+------------------------------------------|
9648
|<print-message> |p |print the current entry |
9649
|------------------------+---------+------------------------------------------|
9650
|<previous-thread> |^P |jump to previous thread |
9651
|------------------------+---------+------------------------------------------|
9652
|<previous-subthread> |Esc p |jump to previous subthread |
9653
|------------------------+---------+------------------------------------------|
9654
|<quit> |Q |save changes to mailbox and quit |
9655
|------------------------+---------+------------------------------------------|
9656
|<exit> |q |exit this menu |
9657
|------------------------+---------+------------------------------------------|
9658
|<reply> |r |reply to a message |
9659
|------------------------+---------+------------------------------------------|
9660
|<recall-message> |R |recall a postponed message |
9661
|------------------------+---------+------------------------------------------|
9662
|<read-thread> |^R |mark the current thread as read |
9663
|------------------------+---------+------------------------------------------|
9664
|<read-subthread> |Esc r |mark the current subthread as read |
9665
|------------------------+---------+------------------------------------------|
9666
|<resend-message> |Esc e |use the current message as a template for |
9667
| | |a new one |
9668
|------------------------+---------+------------------------------------------|
9669
|<save-message> |s |save message/attachment to a file |
9670
|------------------------+---------+------------------------------------------|
9671
|<skip-quoted> |S |skip beyond quoted text |
9672
|------------------------+---------+------------------------------------------|
9673
|<decode-save> |Esc s |make decoded copy (text/plain) and delete |
9674
|------------------------+---------+------------------------------------------|
9675
|<tag-message> |t |tag the current entry |
9676
|------------------------+---------+------------------------------------------|
9677
|<toggle-quoted> |T |toggle display of quoted text |
9678
|------------------------+---------+------------------------------------------|
9679
|<undelete-message> |u |undelete the current entry |
9680
|------------------------+---------+------------------------------------------|
9681
|<undelete-subthread> |Esc u |undelete all messages in subthread |
9682
|------------------------+---------+------------------------------------------|
9683
|<undelete-thread> |^U |undelete all messages in thread |
9684
|------------------------+---------+------------------------------------------|
9685
|<view-attachments> |v |show MIME attachments |
9686
|------------------------+---------+------------------------------------------|
9687
|<show-version> |V |show the Mutt version number and date |
9688
|------------------------+---------+------------------------------------------|
9689
|<search-toggle> |\\ |toggle search pattern coloring |
9690
|------------------------+---------+------------------------------------------|
9691
|<display-address> |@ |display full address of sender |
9692
|------------------------+---------+------------------------------------------|
9693
|<next-new> | |jump to the next new message |
9694
|------------------------+---------+------------------------------------------|
9695
|<pipe-message> || |pipe message/attachment to a shell command|
9696
|------------------------+---------+------------------------------------------|
9697
|<help> |? |this screen |
9698
|------------------------+---------+------------------------------------------|
9699
|<next-page> |<Space> |move to the next page |
9700
|------------------------+---------+------------------------------------------|
9701
|<previous-page> |- |move to the previous page |
9702
|------------------------+---------+------------------------------------------|
9703
|<top> |^ |jump to the top of the message |
9704
|------------------------+---------+------------------------------------------|
9705
|<sync-mailbox> |$ |save changes to mailbox |
9706
|------------------------+---------+------------------------------------------|
9707
|<shell-escape> |! |invoke a command in a subshell |
9708
|------------------------+---------+------------------------------------------|
9709
|<enter-command> |: |enter a muttrc command |
9710
|------------------------+---------+------------------------------------------|
9711
|<buffy-list> |. |list mailboxes with new mail |
9712
|------------------------+---------+------------------------------------------|
9713
|<search> |/ |search for a regular expression |
9714
|------------------------+---------+------------------------------------------|
9715
|<search-reverse> |Esc / |search backwards for a regular expression |
9716
|------------------------+---------+------------------------------------------|
9717
|<search-opposite> | |search for next match in opposite |
9718
| | |direction |
9719
|------------------------+---------+------------------------------------------|
9720
|<next-line> |<Return> |scroll down one line |
9721
|------------------------+---------+------------------------------------------|
9722
|<jump> | |jump to an index number |
9723
|------------------------+---------+------------------------------------------|
9724
|<next-unread> | |jump to the next unread message |
9725
|------------------------+---------+------------------------------------------|
9726
|<previous-new> | |jump to the previous new message |
9727
|------------------------+---------+------------------------------------------|
9728
|<previous-unread> | |jump to the previous unread message |
9729
|------------------------+---------+------------------------------------------|
9730
|<half-up> | |scroll up 1/2 page |
9731
|------------------------+---------+------------------------------------------|
9732
|<half-down> | |scroll down 1/2 page |
9733
|------------------------+---------+------------------------------------------|
9734
|<previous-line> | |scroll up one line |
9735
|------------------------+---------+------------------------------------------|
9736
|<bottom> | |jump to the bottom of the message |
9737
|------------------------+---------+------------------------------------------|
9738
|<parent-message> |P |jump to parent message in thread |
9739
|------------------------+---------+------------------------------------------|
9740
|<check-traditional-pgp> |Esc P |check for classic PGP |
9741
|------------------------+---------+------------------------------------------|
9742
|<mail-key> |Esc k |mail a PGP public key |
9743
|------------------------+---------+------------------------------------------|
9744
|<extract-keys> |^K |extract supported public keys |
9745
|------------------------+---------+------------------------------------------|
9746
|<forget-passphrase> |^F |wipe passphrase(s) from memory |
9747
|------------------------+---------+------------------------------------------|
9748
|<decrypt-copy> | |make decrypted copy |
9749
|------------------------+---------+------------------------------------------|
9750
|<decrypt-save> | |make decrypted copy and delete |
9751
|------------------------+---------+------------------------------------------|
9752
|<what-key> | |display the keycode for a key press |
9753
+-----------------------------------------------------------------------------+
9754
9755
9756
4.4. alias menu
9154
9757
9155
9758
Table 8.5. Default alias function bindings
9156
9759
9157
┌──────────────┬───────────┬──────────────────────────┐
9158
│ Function │Default key│ Description │
9159
├──────────────┼───────────┼──────────────────────────┤
9160
│delete-entry │d │delete the current entry │
9161
├──────────────┼───────────┼──────────────────────────┤
9162
│undelete-entry│u │undelete the current entry│
9163
└──────────────┴───────────┴──────────────────────────┘
9164
9165
9166
4.5. query
9760
+-------------------------------------------------------+
9761
| Function |Default key| Description |
9762
|----------------+-----------+--------------------------|
9763
|<delete-entry> |d |delete the current entry |
9764
|----------------+-----------+--------------------------|
9765
|<undelete-entry>|u |undelete the current entry|
9766
+-------------------------------------------------------+
9767
9768
9769
4.5. query menu
9167
9770
9168
9771
Table 8.6. Default query function bindings
9169
9772
9170
┌────────────┬───────────┬───────────────────────────────────────────┐
9171
│ Function │Default key│ Description │
9172
├────────────┼───────────┼───────────────────────────────────────────┤
9173
│create-alias│a │create an alias from a message sender │
9174
├────────────┼───────────┼───────────────────────────────────────────┤
9175
│mail │m │compose a new mail message │
9176
├────────────┼───────────┼───────────────────────────────────────────┤
9177
│query │Q │query external program for addresses │
9178
├────────────┼───────────┼───────────────────────────────────────────┤
9179
│query-append│A │append new query results to current results│
9180
└────────────┴───────────┴───────────────────────────────────────────┘
9181
9182
9183
4.6. attach
9773
+----------------------------------------------------------------------+
9774
| Function |Default key| Description |
9775
|--------------+-----------+-------------------------------------------|
9776
|<create-alias>|a |create an alias from a message sender |
9777
|--------------+-----------+-------------------------------------------|
9778
|<mail> |m |compose a new mail message |
9779
|--------------+-----------+-------------------------------------------|
9780
|<query> |Q |query external program for addresses |
9781
|--------------+-----------+-------------------------------------------|
9782
|<query-append>|A |append new query results to current results|
9783
+----------------------------------------------------------------------+
9784
9785
9786
4.6. attach menu
9184
9787
9185
9788
Table 8.7. Default attach function bindings
9186
9789
9187
┌─────────────────────┬──────────┬────────────────────────────────────────────┐
9188
│ Function │ Default │ Description │
9189
│ │ key │ │
9190
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9191
│bounce-message │b │remail a message to another user │
9192
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9193
│display-toggle-weed │h │display message and toggle header weeding │
9194
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9195
│edit-type │^E │edit attachment content type │
9196
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9197
│print-entry │p │print the current entry │
9198
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9199
│save-entry │s │save message/attachment to a file │
9200
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9201
│pipe-entry │| │pipe message/attachment to a shell command │
9202
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9203
│view-mailcap │m │force viewing of attachment using mailcap │
9204
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9205
│reply │r │reply to a message │
9206
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9207
│resend-message │ESC e │use the current message as a template for a │
9208
│ │ │new one │
9209
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9210
│group-reply │g │reply to all recipients │
9211
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9212
│list-reply │L │reply to specified mailing list │
9213
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9214
│forward-message │f │forward a message with comments │
9215
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9216
│view-text │T │view attachment as text │
9217
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9218
│view-attach │RET │view attachment using mailcap entry if │
9219
│ │ │necessary │
9220
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9221
│delete-entry │d │delete the current entry │
9222
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9223
│undelete-entry │u │undelete the current entry │
9224
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9225
│collapse-parts │v │Toggle display of subparts │
9226
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9227
│check-traditional-pgp│ESC P │check for classic PGP │
9228
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9229
│extract-keys │^K │extract supported public keys │
9230
├─────────────────────┼──────────┼────────────────────────────────────────────┤
9231
│forget-passphrase │^F │wipe passphrase(s) from memory │
9232
└─────────────────────┴──────────┴────────────────────────────────────────────┘
9233
9234
9235
4.7. compose
9790
+-----------------------------------------------------------------------------+
9791
| Function | Default | Description |
9792
| | key | |
9793
|-----------------------+---------+-------------------------------------------|
9794
|<bounce-message> |b |remail a message to another user |
9795
|-----------------------+---------+-------------------------------------------|
9796
|<display-toggle-weed> |h |display message and toggle header weeding |
9797
|-----------------------+---------+-------------------------------------------|
9798
|<edit-type> |^E |edit attachment content type |
9799
|-----------------------+---------+-------------------------------------------|
9800
|<print-entry> |p |print the current entry |
9801
|-----------------------+---------+-------------------------------------------|
9802
|<save-entry> |s |save message/attachment to a file |
9803
|-----------------------+---------+-------------------------------------------|
9804
|<pipe-entry> || |pipe message/attachment to a shell command |
9805
|-----------------------+---------+-------------------------------------------|
9806
|<view-mailcap> |m |force viewing of attachment using mailcap |
9807
|-----------------------+---------+-------------------------------------------|
9808
|<reply> |r |reply to a message |
9809
|-----------------------+---------+-------------------------------------------|
9810
|<resend-message> |Esc e |use the current message as a template for a|
9811
| | |new one |
9812
|-----------------------+---------+-------------------------------------------|
9813
|<group-reply> |g |reply to all recipients |
9814
|-----------------------+---------+-------------------------------------------|
9815
|<list-reply> |L |reply to specified mailing list |
9816
|-----------------------+---------+-------------------------------------------|
9817
|<forward-message> |f |forward a message with comments |
9818
|-----------------------+---------+-------------------------------------------|
9819
|<view-text> |T |view attachment as text |
9820
|-----------------------+---------+-------------------------------------------|
9821
|<view-attach> |<Return> |view attachment using mailcap entry if |
9822
| | |necessary |
9823
|-----------------------+---------+-------------------------------------------|
9824
|<delete-entry> |d |delete the current entry |
9825
|-----------------------+---------+-------------------------------------------|
9826
|<undelete-entry> |u |undelete the current entry |
9827
|-----------------------+---------+-------------------------------------------|
9828
|<collapse-parts> |v |Toggle display of subparts |
9829
|-----------------------+---------+-------------------------------------------|
9830
|<check-traditional-pgp>|Esc P |check for classic PGP |
9831
|-----------------------+---------+-------------------------------------------|
9832
|<extract-keys> |^K |extract supported public keys |
9833
|-----------------------+---------+-------------------------------------------|
9834
|<forget-passphrase> |^F |wipe passphrase(s) from memory |
9835
+-----------------------------------------------------------------------------+
9836
9837
9838
4.7. compose menu
9236
9839
9237
9840
Table 8.8. Default compose function bindings
9238
9841
9239
┌───────────────────┬──────────┬──────────────────────────────────────────────┐
9240
│ Function │ Default │ Description │
9241
│ │ key │ │
9242
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9243
│attach-file │a │attach file(s) to this message │
9244
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9245
│attach-message │A │attach message(s) to this message │
9246
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9247
│edit-bcc │b │edit the BCC list │
9248
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9249
│edit-cc │c │edit the CC list │
9250
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9251
│copy-file │C │save message/attachment to a file │
9252
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9253
│detach-file │D │delete the current entry │
9254
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9255
│toggle-disposition │^D │toggle disposition between inline/attachment │
9256
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9257
│edit-description │d │edit attachment description │
9258
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9259
│edit-message │e │edit the message │
9260
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9261
│edit-headers │E │edit the message with headers │
9262
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9263
│edit-file │^X e │edit the file to be attached │
9264
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9265
│edit-encoding │^E │edit attachment transfer-encoding │
9266
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9267
│edit-from │ESC f │edit the from field │
9268
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9269
│edit-fcc │f │enter a file to save a copy of this message in│
9270
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9271
│filter-entry │F │filter attachment through a shell command │
9272
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9273
│get-attachment │G │get a temporary copy of an attachment │
9274
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9275
│display-toggle-weed│h │display message and toggle header weeding │
9276
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9277
│ispell │i │run ispell on the message │
9278
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9279
│print-entry │l │print the current entry │
9280
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9281
│edit-mime │m │edit attachment using mailcap entry │
9282
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9283
│new-mime │n │compose new attachment using mailcap entry │
9284
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9285
│postpone-message │P │save this message to send later │
9286
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9287
│edit-reply-to │r │edit the Reply-To field │
9288
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9289
│rename-file │R │rename/move an attached file │
9290
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9291
│edit-subject │s │edit the subject of this message │
9292
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9293
│edit-to │t │edit the TO list │
9294
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9295
│edit-type │^T │edit attachment content type │
9296
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9297
│write-fcc │w │write the message to a folder │
9298
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9299
│toggle-unlink │u │toggle whether to delete file after sending it│
9300
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9301
│toggle-recode │not bound │toggle recoding of this attachment │
9302
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9303
│update-encoding │U │update an attachment's encoding info │
9304
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9305
│view-attach │RET │view attachment using mailcap entry if │
9306
│ │ │necessary │
9307
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9308
│send-message │y │send the message │
9309
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9310
│pipe-entry │| │pipe message/attachment to a shell command │
9311
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9312
│attach-key │ESC k │attach a PGP public key │
9313
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9314
│pgp-menu │p │show PGP options │
9315
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9316
│forget-passphrase │^F │wipe passphrase(s) from memory │
9317
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9318
│smime-menu │S │show S/MIME options │
9319
├───────────────────┼──────────┼──────────────────────────────────────────────┤
9320
│mix │M │send the message through a mixmaster remailer │
9321
│ │ │chain │
9322
└───────────────────┴──────────┴──────────────────────────────────────────────┘
9323
9324
9325
4.8. postpone
9842
+-----------------------------------------------------------------------------+
9843
| Function | Default | Description |
9844
| | key | |
9845
|---------------------+----------+--------------------------------------------|
9846
|<attach-file> |a |attach file(s) to this message |
9847
|---------------------+----------+--------------------------------------------|
9848
|<attach-message> |A |attach message(s) to this message |
9849
|---------------------+----------+--------------------------------------------|
9850
|<edit-bcc> |b |edit the BCC list |
9851
|---------------------+----------+--------------------------------------------|
9852
|<edit-cc> |c |edit the CC list |
9853
|---------------------+----------+--------------------------------------------|
9854
|<copy-file> |C |save message/attachment to a file |
9855
|---------------------+----------+--------------------------------------------|
9856
|<detach-file> |D |delete the current entry |
9857
|---------------------+----------+--------------------------------------------|
9858
|<toggle-disposition> |^D |toggle disposition between inline/attachment|
9859
|---------------------+----------+--------------------------------------------|
9860
|<edit-description> |d |edit attachment description |
9861
|---------------------+----------+--------------------------------------------|
9862
|<edit-message> |e |edit the message |
9863
|---------------------+----------+--------------------------------------------|
9864
|<edit-headers> |E |edit the message with headers |
9865
|---------------------+----------+--------------------------------------------|
9866
|<edit-file> |^X e |edit the file to be attached |
9867
|---------------------+----------+--------------------------------------------|
9868
|<edit-encoding> |^E |edit attachment transfer-encoding |
9869
|---------------------+----------+--------------------------------------------|
9870
|<edit-from> |Esc f |edit the from field |
9871
|---------------------+----------+--------------------------------------------|
9872
|<edit-fcc> |f |enter a file to save a copy of this message |
9873
| | |in |
9874
|---------------------+----------+--------------------------------------------|
9875
|<filter-entry> |F |filter attachment through a shell command |
9876
|---------------------+----------+--------------------------------------------|
9877
|<get-attachment> |G |get a temporary copy of an attachment |
9878
|---------------------+----------+--------------------------------------------|
9879
|<display-toggle-weed>|h |display message and toggle header weeding |
9880
|---------------------+----------+--------------------------------------------|
9881
|<ispell> |i |run ispell on the message |
9882
|---------------------+----------+--------------------------------------------|
9883
|<print-entry> |l |print the current entry |
9884
|---------------------+----------+--------------------------------------------|
9885
|<edit-mime> |m |edit attachment using mailcap entry |
9886
|---------------------+----------+--------------------------------------------|
9887
|<new-mime> |n |compose new attachment using mailcap entry |
9888
|---------------------+----------+--------------------------------------------|
9889
|<postpone-message> |P |save this message to send later |
9890
|---------------------+----------+--------------------------------------------|
9891
|<edit-reply-to> |r |edit the Reply-To field |
9892
|---------------------+----------+--------------------------------------------|
9893
|<rename-file> |R |rename/move an attached file |
9894
|---------------------+----------+--------------------------------------------|
9895
|<edit-subject> |s |edit the subject of this message |
9896
|---------------------+----------+--------------------------------------------|
9897
|<edit-to> |t |edit the TO list |
9898
|---------------------+----------+--------------------------------------------|
9899
|<edit-type> |^T |edit attachment content type |
9900
|---------------------+----------+--------------------------------------------|
9901
|<write-fcc> |w |write the message to a folder |
9902
|---------------------+----------+--------------------------------------------|
9903
|<toggle-unlink> |u |toggle whether to delete file after sending |
9904
| | |it |
9905
|---------------------+----------+--------------------------------------------|
9906
|<toggle-recode> | |toggle recoding of this attachment |
9907
|---------------------+----------+--------------------------------------------|
9908
|<update-encoding> |U |update an attachment's encoding info |
9909
|---------------------+----------+--------------------------------------------|
9910
|<view-attach> |<Return> |view attachment using mailcap entry if |
9911
| | |necessary |
9912
|---------------------+----------+--------------------------------------------|
9913
|<send-message> |y |send the message |
9914
|---------------------+----------+--------------------------------------------|
9915
|<pipe-entry> || |pipe message/attachment to a shell command |
9916
|---------------------+----------+--------------------------------------------|
9917
|<attach-key> |Esc k |attach a PGP public key |
9918
|---------------------+----------+--------------------------------------------|
9919
|<pgp-menu> |p |show PGP options |
9920
|---------------------+----------+--------------------------------------------|
9921
|<forget-passphrase> |^F |wipe passphrase(s) from memory |
9922
|---------------------+----------+--------------------------------------------|
9923
|<smime-menu> |S |show S/MIME options |
9924
|---------------------+----------+--------------------------------------------|
9925
|<mix> |M |send the message through a mixmaster |
9926
| | |remailer chain |
9927
+-----------------------------------------------------------------------------+
9928
9929
9930
4.8. postpone menu
9326
9931
9327
9932
Table 8.9. Default postpone function bindings
9328
9933
9329
┌──────────────┬───────────┬──────────────────────────┐
9330
│ Function │Default key│ Description │
9331
├──────────────┼───────────┼──────────────────────────┤
9332
│delete-entry │d │delete the current entry │
9333
├──────────────┼───────────┼──────────────────────────┤
9334
│undelete-entry│u │undelete the current entry│
9335
└──────────────┴───────────┴──────────────────────────┘
9336
9337
9338
4.9. browser
9934
+-------------------------------------------------------+
9935
| Function |Default key| Description |
9936
|----------------+-----------+--------------------------|
9937
|<delete-entry> |d |delete the current entry |
9938
|----------------+-----------+--------------------------|
9939
|<undelete-entry>|u |undelete the current entry|
9940
+-------------------------------------------------------+
9941
9942
9943
4.9. browser menu
9339
9944
9340
9945
Table 8.10. Default browser function bindings
9341
9946
9342
┌─────────────────┬───────────┬───────────────────────────────────────────────┐
9343
│ Function │Default key│ Description │
9344
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9345
│change-dir │c │change directories │
9346
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9347
│display-filename │@ │display the currently selected file's name │
9348
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9349
│enter-mask │m │enter a file mask │
9350
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9351
│sort │o │sort messages │
9352
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9353
│sort-reverse │O │sort messages in reverse order │
9354
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9355
│select-new │N │select a new file in this directory │
9356
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9357
│check-new │not bound │check mailboxes for new mail │
9358
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9359
│toggle-mailboxes │TAB │toggle whether to browse mailboxes or all files│
9360
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9361
│view-file │Space │view file │
9362
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9363
│buffy-list │. │list mailboxes with new mail │
9364
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9365
│create-mailbox │C │create a new mailbox (IMAP only) │
9366
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9367
│delete-mailbox │d │delete the current mailbox (IMAP only) │
9368
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9369
│rename-mailbox │r │rename the current mailbox (IMAP only) │
9370
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9371
│subscribe │s │subscribe to current mailbox (IMAP only) │
9372
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9373
│unsubscribe │u │unsubscribe from current mailbox (IMAP only) │
9374
├─────────────────┼───────────┼───────────────────────────────────────────────┤
9375
│toggle-subscribed│T │toggle view all/subscribed mailboxes (IMAP │
9376
│ │ │only) │
9377
└─────────────────┴───────────┴───────────────────────────────────────────────┘
9378
9379
9380
4.10. pgp
9947
+-----------------------------------------------------------------------------+
9948
| Function | Default | Description |
9949
| | key | |
9950
|-------------------+----------+----------------------------------------------|
9951
|<change-dir> |c |change directories |
9952
|-------------------+----------+----------------------------------------------|
9953
|<display-filename> |@ |display the currently selected file's name |
9954
|-------------------+----------+----------------------------------------------|
9955
|<enter-mask> |m |enter a file mask |
9956
|-------------------+----------+----------------------------------------------|
9957
|<sort> |o |sort messages |
9958
|-------------------+----------+----------------------------------------------|
9959
|<sort-reverse> |O |sort messages in reverse order |
9960
|-------------------+----------+----------------------------------------------|
9961
|<select-new> |N |select a new file in this directory |
9962
|-------------------+----------+----------------------------------------------|
9963
|<check-new> | |check mailboxes for new mail |
9964
|-------------------+----------+----------------------------------------------|
9965
|<toggle-mailboxes> |<Tab> |toggle whether to browse mailboxes or all |
9966
| | |files |
9967
|-------------------+----------+----------------------------------------------|
9968
|<view-file> |<Space> |view file |
9969
|-------------------+----------+----------------------------------------------|
9970
|<buffy-list> |. |list mailboxes with new mail |
9971
|-------------------+----------+----------------------------------------------|
9972
|<create-mailbox> |C |create a new mailbox (IMAP only) |
9973
|-------------------+----------+----------------------------------------------|
9974
|<delete-mailbox> |d |delete the current mailbox (IMAP only) |
9975
|-------------------+----------+----------------------------------------------|
9976
|<rename-mailbox> |r |rename the current mailbox (IMAP only) |
9977
|-------------------+----------+----------------------------------------------|
9978
|<subscribe> |s |subscribe to current mailbox (IMAP only) |
9979
|-------------------+----------+----------------------------------------------|
9980
|<unsubscribe> |u |unsubscribe from current mailbox (IMAP only) |
9981
|-------------------+----------+----------------------------------------------|
9982
|<toggle-subscribed>|T |toggle view all/subscribed mailboxes (IMAP |
9983
| | |only) |
9984
+-----------------------------------------------------------------------------+
9985
9986
9987
4.10. pgp menu
9381
9988
9382
9989
Table 8.11. Default pgp function bindings
9383
9990
9384
┌──────────┬───────────┬───────────────────────┐
9385
│ Function │Default key│ Description │
9386
├──────────┼───────────┼───────────────────────┤
9387
│verify-key│c │verify a PGP public key│
9388
├──────────┼───────────┼───────────────────────┤
9389
│view-name │% │view the key's user id │
9390
└──────────┴───────────┴───────────────────────┘
9391
9392
9393
4.11. smime
9991
+------------------------------------------------+
9992
| Function |Default key| Description |
9993
|------------+-----------+-----------------------|
9994
|<verify-key>|c |verify a PGP public key|
9995
|------------+-----------+-----------------------|
9996
|<view-name> |% |view the key's user id |
9997
+------------------------------------------------+
9998
9999
10000
4.11. smime menu
9394
10001
9395
10002
Table 8.12. Default smime function bindings
9396
10003
9397
┌──────────┬───────────┬───────────────────────┐
9398
│ Function │Default key│ Description │
9399
├──────────┼───────────┼───────────────────────┤
9400
│verify-key│c │verify a PGP public key│
9401
├──────────┼───────────┼───────────────────────┤
9402
│view-name │% │view the key's user id │
9403
└──────────┴───────────┴───────────────────────┘
9404
9405
9406
4.12. mix
10004
+------------------------------------------------+
10005
| Function |Default key| Description |
10006
|------------+-----------+-----------------------|
10007
|<verify-key>|c |verify a PGP public key|
10008
|------------+-----------+-----------------------|
10009
|<view-name> |% |view the key's user id |
10010
+------------------------------------------------+
10011
10012
10013
4.12. mix menu
9407
10014
9408
10015
Table 8.13. Default mix function bindings
9409
10016
9410
┌──────────┬───────────┬────────────────────────────────────────┐
9411
│ Function │Default key│ Description │
9412
├──────────┼───────────┼────────────────────────────────────────┤
9413
│accept │RET │Accept the chain constructed │
9414
├──────────┼───────────┼────────────────────────────────────────┤
9415
│append │a │Append a remailer to the chain │
9416
├──────────┼───────────┼────────────────────────────────────────┤
9417
│insert │i │Insert a remailer into the chain │
9418
├──────────┼───────────┼────────────────────────────────────────┤
9419
│delete │d │Delete a remailer from the chain │
9420
├──────────┼───────────┼────────────────────────────────────────┤
9421
│chain-prev│left │Select the previous element of the chain│
9422
├──────────┼───────────┼────────────────────────────────────────┤
9423
│chain-next│right │Select the next element of the chain │
9424
└──────────┴───────────┴────────────────────────────────────────┘
9425
9426
9427
4.13. editor
10017
+-----------------------------------------------------------------+
10018
| Function |Default key| Description |
10019
|------------+-----------+----------------------------------------|
10020
|<accept> |<Return> |Accept the chain constructed |
10021
|------------+-----------+----------------------------------------|
10022
|<append> |a |Append a remailer to the chain |
10023
|------------+-----------+----------------------------------------|
10024
|<insert> |i |Insert a remailer into the chain |
10025
|------------+-----------+----------------------------------------|
10026
|<delete> |d |Delete a remailer from the chain |
10027
|------------+-----------+----------------------------------------|
10028
|<chain-prev>|<Left> |Select the previous element of the chain|
10029
|------------+-----------+----------------------------------------|
10030
|<chain-next>|<Right> |Select the next element of the chain |
10031
+-----------------------------------------------------------------+
10032
10033
10034
4.13. editor menu
9428
10035
9429
10036
Table 8.14. Default editor function bindings
9430
10037
9431
┌───────────────┬───────────┬─────────────────────────────────────────────────┐
9432
│ Function │Default key│ Description │
9433
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9434
│bol │^A │jump to the beginning of the line │
9435
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9436
│backward-char │^B │move the cursor one character to the left │
9437
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9438
│backward-word │ESC b │move the cursor to the beginning of the word │
9439
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9440
│capitalize-word│ESC c │capitalize the word │
9441
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9442
│downcase-word │ESC l │convert the word to lower case │
9443
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9444
│upcase-word │ESC u │convert the word to upper case │
9445
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9446
│delete-char │^D │delete the char under the cursor │
9447
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9448
│eol │^E │jump to the end of the line │
9449
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9450
│forward-char │^F │move the cursor one character to the right │
9451
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9452
│forward-word │ESC f │move the cursor to the end of the word │
9453
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9454
│backspace │Backspace │delete the char in front of the cursor │
9455
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9456
│kill-eol │^K │delete chars from cursor to end of line │
9457
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9458
│kill-eow │ESC d │delete chars from the cursor to the end of the │
9459
│ │ │word │
9460
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9461
│kill-line │^U │delete all chars on the line │
9462
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9463
│quote-char │^V │quote the next typed key │
9464
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9465
│kill-word │^W │delete the word in front of the cursor │
9466
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9467
│complete │TAB │complete filename or alias │
9468
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9469
│complete-query │^T │complete address with query │
9470
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9471
│buffy-cycle │Space │cycle among incoming mailboxes │
9472
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9473
│history-up │not bound │scroll up through the history list │
9474
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9475
│history-down │not bound │scroll down through the history list │
9476
├───────────────┼───────────┼─────────────────────────────────────────────────┤
9477
│transpose-chars│not bound │transpose character under cursor with previous │
9478
└───────────────┴───────────┴─────────────────────────────────────────────────┘
10038
+-----------------------------------------------------------------------------+
10039
| Function |Default key| Description |
10040
|-----------------+-----------+-----------------------------------------------|
10041
|<bol> |^A |jump to the beginning of the line |
10042
|-----------------+-----------+-----------------------------------------------|
10043
|<backward-char> |^B |move the cursor one character to the left |
10044
|-----------------+-----------+-----------------------------------------------|
10045
|<backward-word> |Esc b |move the cursor to the beginning of the word |
10046
|-----------------+-----------+-----------------------------------------------|
10047
|<capitalize-word>|Esc c |capitalize the word |
10048
|-----------------+-----------+-----------------------------------------------|
10049
|<downcase-word> |Esc l |convert the word to lower case |
10050
|-----------------+-----------+-----------------------------------------------|
10051
|<upcase-word> |Esc u |convert the word to upper case |
10052
|-----------------+-----------+-----------------------------------------------|
10053
|<delete-char> |^D |delete the char under the cursor |
10054
|-----------------+-----------+-----------------------------------------------|
10055
|<eol> |^E |jump to the end of the line |
10056
|-----------------+-----------+-----------------------------------------------|
10057
|<forward-char> |^F |move the cursor one character to the right |
10058
|-----------------+-----------+-----------------------------------------------|
10059
|<forward-word> |Esc f |move the cursor to the end of the word |
10060
|-----------------+-----------+-----------------------------------------------|
10061
|<backspace> |<Backspace>|delete the char in front of the cursor |
10062
|-----------------+-----------+-----------------------------------------------|
10063
|<kill-eol> |^K |delete chars from cursor to end of line |
10064
|-----------------+-----------+-----------------------------------------------|
10065
|<kill-eow> |Esc d |delete chars from the cursor to the end of the |
10066
| | |word |
10067
|-----------------+-----------+-----------------------------------------------|
10068
|<kill-line> |^U |delete all chars on the line |
10069
|-----------------+-----------+-----------------------------------------------|
10070
|<quote-char> |^V |quote the next typed key |
10071
|-----------------+-----------+-----------------------------------------------|
10072
|<kill-word> |^W |delete the word in front of the cursor |
10073
|-----------------+-----------+-----------------------------------------------|
10074
|<complete> |<Tab> |complete filename or alias |
10075
|-----------------+-----------+-----------------------------------------------|
10076
|<complete-query> |^T |complete address with query |
10077
|-----------------+-----------+-----------------------------------------------|
10078
|<buffy-cycle> |<Space> |cycle among incoming mailboxes |
10079
|-----------------+-----------+-----------------------------------------------|
10080
|<history-up> | |scroll up through the history list |
10081
|-----------------+-----------+-----------------------------------------------|
10082
|<history-down> | |scroll down through the history list |
10083
|-----------------+-----------+-----------------------------------------------|
10084
|<transpose-chars>| |transpose character under cursor with previous |
10085
+-----------------------------------------------------------------------------+
9479
10086
9480
10087
9481
10088
Chapter 9. Miscellany
9492
10099
9493
10100
The following people have been very helpful to the development of Mutt:
9494
10101
9495
Vikas Agnihotri <vikasa@writeme.com>,
9496
Francois Berjon <Francois.Berjon@aar.alcatel-alsthom.fr>,
9497
Aric Blumer <aric@fore.com>,
9498
John Capo <jc@irbs.com>,
9499
David Champion <dgc@uchicago.edu>,
9500
Brendan Cully <brendan@kublai.com>,
9501
Liviu Daia <daia@stoilow.imar.ro>,
9502
Thomas E. Dickey <dickey@herndon4.his.com>,
9503
David DeSimone <fox@convex.hp.com>,
9504
Nickolay N. Dudorov <nnd@wint.itfs.nsk.su>,
9505
Ruslan Ermilov <ru@freebsd.org>,
9506
Edmund Grimley Evans <edmundo@rano.org>,
9507
Michael Finken <finken@conware.de>,
9508
Sven Guckes <guckes@math.fu-berlin.de>,
9509
Lars Hecking <lhecking@nmrc.ie>,
9510
Mark Holloman <holloman@nando.net>,
9511
Andreas Holzmann <holzmann@fmi.uni-passau.de>,
9512
Marco d'Itri <md@linux.it>,
9513
Björn Jacke <bjacke@suse.com>,
9514
Byrial Jensen <byrial@image.dk>,
9515
David Jeske <jeske@igcom.net>,
9516
Christophe Kalt <kalt@hugo.int-evry.fr>,
9517
Tommi Komulainen <Tommi.Komulainen@iki.fi>,
9518
Felix von Leitner (a.k.a ``Fefe'') <leitner@math.fu-berlin.de>,
9519
Brandon Long <blong@fiction.net>,
9520
Jimmy Mäkelä <jmy@flashback.net>,
9521
Lars Marowsky-Bree <lmb@pointer.in-minden.de>,
9522
Thomas ``Mike'' Michlmayr <mike@cosy.sbg.ac.at>,
9523
Andrew W. Nosenko <awn@bcs.zp.ua>,
9524
David O'Brien <obrien@Nuxi.cs.ucdavis.edu>,
9525
Clint Olsen <olsenc@ichips.intel.com>,
9526
Park Myeong Seok <pms@romance.kaist.ac.kr>,
9527
Thomas Parmelan <tom@ankh.fr.eu.org>,
9528
Ollivier Robert <roberto@keltia.freenix.fr>,
9529
Thomas Roessler <roessler@does-not-exist.org>,
9530
Roland Rosenfeld <roland@spinnaker.de>,
9531
TAKIZAWA Takashi <taki@luna.email.ne.jp>,
9532
Allain Thivillon <Allain.Thivillon@alma.fr>,
9533
Gero Treuner <gero@70t.de>,
9534
Vsevolod Volkov <vvv@lucky.net>,
9535
Ken Weinert <kenw@ihs.com>
10102
* Vikas Agnihotri <vikasa@writeme.com>
10103
10104
* Francois Berjon <Francois.Berjon@aar.alcatel-alsthom.fr>
10105
10106
* Aric Blumer <aric@fore.com>
10107
10108
* John Capo <jc@irbs.com>
10109
10110
* David Champion <dgc@uchicago.edu>
10111
10112
* Brendan Cully <brendan@kublai.com>
10113
10114
* Liviu Daia <daia@stoilow.imar.ro>
10115
10116
* Thomas E. Dickey <dickey@herndon4.his.com>
10117
10118
* David DeSimone <fox@convex.hp.com>
10119
10120
* Nickolay N. Dudorov <nnd@wint.itfs.nsk.su>
10121
10122
* Ruslan Ermilov <ru@freebsd.org>
10123
10124
* Edmund Grimley Evans <edmundo@rano.org>
10125
10126
* Michael Finken <finken@conware.de>
10127
10128
* Sven Guckes <guckes@math.fu-berlin.de>
10129
10130
* Lars Hecking <lhecking@nmrc.ie>
10131
10132
* Mark Holloman <holloman@nando.net>
10133
10134
* Andreas Holzmann <holzmann@fmi.uni-passau.de>
10135
10136
* Marco d'Itri <md@linux.it>
10137
10138
* Bj?rn Jacke <bjacke@suse.com>
10139
10140
* Byrial Jensen <byrial@image.dk>
10141
10142
* David Jeske <jeske@igcom.net>
10143
10144
* Christophe Kalt <kalt@hugo.int-evry.fr>
10145
10146
* Tommi Komulainen <Tommi.Komulainen@iki.fi>
10147
10148
* Felix von Leitner (a.k.a ?Fefe?) <leitner@math.fu-berlin.de>
10149
10150
* Brandon Long <blong@fiction.net>
10151
10152
* Jimmy M?kel? <jmy@flashback.net>
10153
10154
* Lars Marowsky-Bree <lmb@pointer.in-minden.de>
10155
10156
* Thomas ?Mike? Michlmayr <mike@cosy.sbg.ac.at>
10157
10158
* Andrew W. Nosenko <awn@bcs.zp.ua>
10159
10160
* David O'Brien <obrien@Nuxi.cs.ucdavis.edu>
10161
10162
* Clint Olsen <olsenc@ichips.intel.com>
10163
10164
* Park Myeong Seok <pms@romance.kaist.ac.kr>
10165
10166
* Thomas Parmelan <tom@ankh.fr.eu.org>
10167
10168
* Ollivier Robert <roberto@keltia.freenix.fr>
10169
10170
* Thomas Roessler <roessler@does-not-exist.org>
10171
10172
* Roland Rosenfeld <roland@spinnaker.de>
10173
10174
* Rocco Rutte <pdmef@gmx.net>
10175
10176
* TAKIZAWA Takashi <taki@luna.email.ne.jp>
10177
10178
* Allain Thivillon <Allain.Thivillon@alma.fr>
10179
10180
* Gero Treuner <gero@70t.de>
10181
10182
* Vsevolod Volkov <vvv@lucky.net>
10183
10184
* Ken Weinert <kenw@ihs.com>
9536
10185
9537
10186
2. About this document
9538
10187
Loggerhead is a web-based interface for Breezy
Version: 2.0.1