553f03b65705b8d3e868f0d5f4e3a4e03759f02e
[apps/madmutt.git] / doc / manual.sgml.tail
1 </sect1>
2
3 <sect1 id="functions">
4 <title>Functions</title>
5
6 <para>
7 The following is the list of available functions listed by the mapping
8 in which they are available.  The default key setting is given, and an
9 explanation of what the function does.  The key bindings of these
10 functions can be changed with the <link linkend="bind">bind</link>
11 command.
12 </para>
13
14 <sect2>
15 <title>generic</title>
16
17 <para>
18 The <emphasis>generic</emphasis> menu is not a real menu, but specifies common functions
19 (such as movement) available in all menus except for <emphasis>pager</emphasis> and
20 <emphasis>editor</emphasis>.  Changing settings for this menu will affect the default
21 bindings for all menus (except as noted).
22 </para>
23
24 <para>
25
26 <screen>
27 bottom-page                L   move to the bottom of the page
28 current-bottom     not bound   move current entry to bottom of page
29 current-middle     not bound   move current entry to middle of page
30 current-top        not bound   move current entry to top of page
31 enter-command              :   enter a muttngrc command
32 exit                       q   exit this menu
33 first-entry                =   move to the first entry
34 half-down                  ]   scroll down 1/2 page
35 half-up                    [   scroll up 1/2 page
36 help                       ?   this screen
37 jump                  number   jump to an index number
38 last-entry                 *   move to the last entry
39 middle-page                M   move to the middle of the page
40 next-entry                 j   move to the next entry
41 next-line                  &gt;   scroll down one line
42 next-page                  z   move to the next page
43 previous-entry             k   move to the previous entry
44 previous-line              &lt;   scroll up one line
45 previous-page              Z   move to the previous page
46 refresh                   ^L   clear and redraw the screen
47 search                     /   search for a regular expression
48 search-next                n   search for next match
49 search-opposite    not bound   search for next match in opposite direction
50 search-reverse         ESC /   search backwards for a regular expression
51 select-entry             RET   select the current entry
52 shell-escape               !   run a program in a subshell
53 tag-entry                  t   toggle the tag on the current entry
54 tag-prefix                 ;   apply next command to tagged entries
55 tag-prefix-cond    not bound   apply next function ONLY to tagged messages
56 top-page                   H   move to the top of the page
57 what-key           not bound   display the keycode for a key press
58 </screen>
59
60 </para>
61
62 </sect2>
63
64 <sect2>
65 <title>index</title>
66
67 <para>
68
69 <screen>
70 bounce-message             b   remail a message to another user
71 change-folder              c   open a different folder
72 change-folder-readonly ESC c   open a different folder in read only mode
73 check-traditional-pgp  ESC P   check for classic pgp
74 clear-flag                 W   clear a status flag from a message
75 copy-message               C   copy a message to a file/mailbox
76 create-alias               a   create an alias from a message sender
77 decode-copy            ESC C   decode a message and copy it to a file/mailbox
78 decode-save            ESC s   decode a message and save it to a file/mailbox
79 delete-message             d   delete the current entry
80 delete-pattern             D   delete messages matching a pattern
81 delete-subthread       ESC d   delete all messages in subthread
82 delete-thread             ^D   delete all messages in thread
83 display-address            @   display full address of sender
84 display-toggle-weed        h   display message and toggle header weeding
85 display-message          RET   display a message
86 edit                       e   edit the current message
87 edit-type                 ^E   edit the current message's Content-Type
88 exit                       x   exit without saving changes
89 extract-keys              ^K   extract PGP public keys
90 fetch-mail                 G   retrieve mail from POP server
91 flag-message               F   toggle a message's 'important' flag
92 forget-passphrase         ^F   wipe PGP passphrase from memory
93 forward-message            f   forward a message with comments
94 group-reply                g   reply to all recipients
95 limit                      l   show only messages matching a pattern
96 list-reply                 L   reply to specified mailing list
97 mail                       m   compose a new mail message
98 mail-key               ESC k   mail a PGP public key
99 next-new                 TAB   jump to the next new message
100 next-subthread         ESC n   jump to the next subthread
101 next-thread               ^N   jump to the next thread
102 next-undeleted             j   move to the next undeleted message
103 next-unread        not bound   jump to the next unread message
104 parent-message             P   jump to parent message in thread
105 pipe-message               |   pipe message/attachment to a shell command
106 previous-new         ESC TAB   jump to the previous new message
107 previous-page              Z   move to the previous page
108 previous-subthread     ESC p   jump to previous subthread
109 previous-thread           ^P   jump to previous thread
110 previous-undeleted         k   move to the last undelete message
111 previous-unread    not bound   jump to the previous unread message
112 print-message              p   print the current entry
113 query                      Q   query external program for addresses
114 quit                       q   save changes to mailbox and quit
115 read-subthread         ESC r   mark the current subthread as read
116 read-thread               ^R   mark the current thread as read
117 recall-message             R   recall a postponed message
118 reply                      r   reply to a message
119 resend-message         ESC e   resend message and preserve MIME structure
120 save-message               s   save message/attachment to a file
121 set-flag                   w   set a status flag on a message
122 show-version               V   show the Mutt-ng version number and date
123 show-limit             ESC l   show currently active limit pattern, if any
124 sort-mailbox               o   sort messages
125 sort-reverse               O   sort messages in reverse order
126 sync-mailbox               $   save changes to mailbox
127 tag-pattern                T   tag messages matching a pattern
128 tag-thread             ESC t   tag/untag all messages in the current thread
129 toggle-new                 N   toggle a message's 'new' flag
130 toggle-write               %   toggle whether the mailbox will be rewritten
131 undelete-message           u   undelete the current entry
132 undelete-pattern           U   undelete messages matching a pattern
133 undelete-subthread     ESC u   undelete all messages in subthread
134 undelete-thread           ^U   undelete all messages in thread
135 untag-pattern             ^T   untag messages matching a pattern
136 view-attachments           v   show MIME attachments
137 </screen>
138
139 </para>
140
141 </sect2>
142
143 <sect2>
144 <title>pager</title>
145
146 <para>
147
148 <screen>
149 bottom             not bound   jump to the bottom of the message
150 bounce-message             b   remail a message to another user
151 change-folder              c   open a different folder
152 change-folder-readonly ESC c   open a different folder in read only mode
153 check-traditional-pgp  ESC P   check for classic pgp
154 copy-message               C   copy a message to a file/mailbox
155 create-alias               a   create an alias from a message sender
156 decode-copy            ESC C   decode a message and copy it to a file/mailbox
157 decode-save            ESC s   decode a message and save it to a file/mailbox
158 delete-message             d   delete the current entry
159 delete-subthread       ESC d   delete all messages in subthread
160 delete-thread             ^D   delete all messages in thread
161 display-address            @   display full address of sender
162 display-toggle-weed        h   display message and toggle header weeding
163 edit                       e   edit the current message
164 edit-type                 ^E   edit the current message's Content-Type
165 enter-command              :   enter a muttngrc command
166 exit                       i   return to the main-menu
167 extract-keys              ^K   extract PGP public keys
168 flag-message               F   toggle a message's 'important' flag
169 forget-passphrase         ^F   wipe PGP passphrase from memory
170 forward-message            f   forward a message with comments
171 group-reply                g   reply to all recipients
172 half-up            not bound   move up one-half page
173 half-down          not bound   move down one-half page
174 help                       ?   this screen
175 list-reply                 L   reply to specified mailing list
176 mail                       m   compose a new mail message
177 mail-key               ESC k   mail a PGP public key
178 mark-as-new                N   toggle a message's 'new' flag
179 next-line                RET   scroll down one line
180 next-entry                 J   move to the next entry
181 next-new                 TAB   jump to the next new message
182 next-page                      move to the next page
183 next-subthread         ESC n   jump to the next subthread
184 next-thread               ^N   jump to the next thread
185 next-undeleted             j   move to the next undeleted message
186 next-unread        not bound   jump to the next unread message
187 parent-message             P   jump to parent message in thread
188 pipe-message               |   pipe message/attachment to a shell command
189 previous-line      BackSpace   scroll up one line
190 previous-entry             K   move to the previous entry
191 previous-new       not bound   jump to the previous new message
192 previous-page              -   move to the previous page
193 previous-subthread     ESC p   jump to previous subthread
194 previous-thread           ^P   jump to previous thread
195 previous-undeleted         k   move to the last undelete message
196 previous-unread    not bound   jump to the previous unread message
197 print-message              p   print the current entry
198 quit                       Q   save changes to mailbox and quit
199 read-subthread         ESC r   mark the current subthread as read
200 read-thread               ^R   mark the current thread as read
201 recall-message             R   recall a postponed message
202 redraw-screen             ^L   clear and redraw the screen
203 reply                      r   reply to a message
204 save-message               s   save message/attachment to a file
205 search                     /   search for a regular expression
206 search-next                n   search for next match
207 search-opposite    not bound   search for next match in opposite direction
208 search-reverse         ESC /   search backwards for a regular expression
209 search-toggle              \   toggle search pattern coloring
210 shell-escape               !   invoke a command in a subshell
211 show-version               V   show the Mutt-ng version number and date
212 skip-quoted                S   skip beyond quoted text
213 sync-mailbox               $   save changes to mailbox
214 tag-message                t   tag a message
215 toggle-quoted              T   toggle display of quoted text
216 top                        ^   jump to the top of the message
217 undelete-message           u   undelete the current entry
218 undelete-subthread     ESC u   undelete all messages in subthread
219 undelete-thread           ^U   undelete all messages in thread
220 view-attachments           v   show MIME attachments
221 </screen>
222
223 </para>
224
225 </sect2>
226
227 <sect2>
228 <title>alias</title>
229
230 <para>
231
232 <screen>
233 search                     /   search for a regular expression
234 search-next                n   search for next match
235 search-reverse         ESC /   search backwards for a regular expression
236 </screen>
237
238 </para>
239
240 </sect2>
241
242 <sect2>
243 <title>query</title>
244
245 <para>
246
247 <screen>
248 create-alias               a   create an alias from a message sender
249 mail                       m   compose a new mail message
250 query                      Q   query external program for addresses
251 query-append               A   append new query results to current results
252 search                     /   search for a regular expression
253 search-next                n   search for next match
254 search-opposite    not bound   search for next match in opposite direction
255 search-reverse         ESC /   search backwards for a regular expression
256 </screen>
257
258 </para>
259
260 </sect2>
261
262 <sect2>
263 <title>attach</title>
264
265 <para>
266
267 <screen>
268 bounce-message             b   remail a message to another user
269 collapse-parts             v   toggle display of subparts
270 delete-entry               d   delete the current entry
271 display-toggle-weed        h   display message and toggle header weeding
272 edit-type                 ^E   edit the current entry's Content-Type
273 extract-keys              ^K   extract PGP public keys
274 forward-message            f   forward a message with comments
275 group-reply                g   reply to all recipients
276 list-reply                 L   reply to specified mailing list
277 pipe-entry                 |   pipe message/attachment to a shell command
278 print-entry                p   print the current entry
279 reply                      r   reply to a message
280 resend-message         ESC e   resend message and preserve MIME structure
281 save-entry                 s   save message/attachment to a file
282 undelete-entry             u   undelete the current entry
283 view-attach              RET   view attachment using mailcap entry if necessary
284 view-mailcap               m   force viewing of attachment using mailcap
285 view-text                  T   view attachment as text
286 </screen>
287
288 </para>
289
290 </sect2>
291
292 <sect2>
293 <title>compose</title>
294
295 <para>
296
297 <screen>
298 attach-file                a   attach a file(s) to this message
299 attach-message             A   attach message(s) to this message
300 attach-key             ESC k   attach a PGP public key
301 copy-file                  C   save message/attachment to a file
302 detach-file                D   delete the current entry
303 display-toggle-weed        h   display message and toggle header weeding
304 edit-bcc                   b   edit the BCC list
305 edit-cc                    c   edit the CC list
306 edit-description           d   edit attachment description
307 edit-encoding             ^E   edit attachment transfer-encoding
308 edit-fcc                   f   enter a file to save a copy of this message in
309 edit-from              ESC f   edit the from: field
310 edit-file               ^X e   edit the file to be attached
311 edit-headers               E   edit the message with headers
312 edit                       e   edit the message
313 edit-mime                  m   edit attachment using mailcap entry
314 edit-reply-to              r   edit the Reply-To field
315 edit-subject               s   edit the subject of this message
316 edit-to                    t   edit the TO list
317 edit-type                 ^T   edit attachment type
318 filter-entry               F   filter attachment through a shell command
319 forget-passphrase         ^F   wipe PGP passphrase from memory
320 ispell                     i   run ispell on the message
321 new-mime                   n   compose new attachment using mailcap entry
322 pgp-menu                   p   show PGP options
323 pipe-entry                 |   pipe message/attachment to a shell command
324 postpone-message           P   save this message to send later
325 print-entry                l   print the current entry
326 rename-file                R   rename/move an attached file
327 send-message               y   send the message
328 toggle-unlink              u   toggle whether to delete file after sending it
329 view-attach              RET   view attachment using mailcap entry if necessary
330 write-fcc                  w   write the message to a folder
331 </screen>
332
333 </para>
334
335 </sect2>
336
337 <sect2>
338 <title>postpone</title>
339
340 <para>
341
342 <screen>
343 delete-entry               d   delete the current entry
344 undelete-entry             u   undelete the current entry
345 </screen>
346
347 </para>
348
349 </sect2>
350
351 <sect2>
352 <title>browser</title>
353
354 <para>
355
356 <screen>
357 change-dir                 c   change directories
358 check-new                TAB   check mailboxes for new mail
359 enter-mask                 m   enter a file mask
360 search                     /   search for a regular expression
361 search-next                n   search for next match
362 search-reverse         ESC /   search backwards for a regular expression
363 select-new                 N   select a new file in this directory
364 sort                       o   sort messages
365 sort-reverse               O   sort messages in reverse order
366 toggle-mailboxes         TAB   toggle whether to browse mailboxes or all files
367 view-file              SPACE   view file
368 subscribe                  s   subscribe to current mailbox (IMAP Only)
369 unsubscribe                u   unsubscribe to current mailbox (IMAP Only)
370 toggle-subscribed          T   toggle view all/subscribed mailboxes (IMAP Only)
371 </screen>
372
373 </para>
374
375 </sect2>
376
377 <sect2>
378 <title>pgp</title>
379
380 <para>
381
382 <screen>
383 view-name                  %   view the key's user id
384 verify-key                 c   verify a PGP public key
385 </screen>
386
387 </para>
388
389 </sect2>
390
391 <sect2>
392 <title>editor</title>
393
394 <para>
395
396 <screen>
397 backspace          BackSpace   delete the char in front of the cursor
398 backward-char             ^B   move the cursor one character to the left
399 backward-word          ESC b   move the cursor to the previous word
400 bol                       ^A   jump to the beginning of the line
401 buffy-cycle            Space   cycle among incoming mailboxes
402 capitalize-word        ESC c   uppercase the first character in the word
403 complete                 TAB   complete filename or alias
404 complete-query            ^T   complete address with query
405 delete-char               ^D   delete the char under the cursor
406 downcase-word          ESC l   lowercase all characters in current word
407 eol                       ^E   jump to the end of the line
408 forward-char              ^F   move the cursor one character to the right
409 forward-word           ESC f   move the cursor to the next word
410 history-down       not bound   scroll down through the history list
411 history-up         not bound   scroll up through the history list
412 kill-eol                  ^K   delete chars from cursor to end of line
413 kill-eow               ESC d   delete chars from cursor to end of word
414 kill-line                 ^U   delete all chars on the line
415 kill-word                 ^W   delete the word in front of the cursor
416 quote-char                ^V   quote the next typed key
417 transpose-chars    not bound   transpose character under cursor with previous
418 upcase-word            ESC u   uppercase all characters in current word
419 </screen>
420
421 </para>
422
423 </sect2>
424
425 </sect1>
426
427 </chapter>
428
429 <chapter>
430 <title>Miscellany</title>
431
432 <sect1>
433 <title>Acknowledgments</title>
434
435 <para> Kari Hurtta <ulink URL="mailto:kari.hurtta@fmi.fi"
436 >&lt;kari.hurtta@fmi.fi&gt;</ulink> co-developed the original MIME
437 >parsing code back in the ELM-ME days.
438 </para>
439
440 <para> The following people have been very helpful to the development of
441 Mutt: </para>
442
443 <para> Vikas Agnihotri <ulink
444     URL="mailto:vikasa@writeme.com">&lt;vikasa@writeme.com&gt;</ulink>,
445
446 Francois Berjon <ulink
447   URL="mailto:Francois.Berjon@aar.alcatel-alsthom.fr">&lt;Francois.Berjon@aar.alcatel-alsthom.fr&gt;</ulink>,
448
449 Aric Blumer <ulink URL="mailto:aric@fore.com"
450   >&lt;aric@fore.com&gt;</ulink>,
451
452 John Capo <ulink URL="mailto:jc@irbs.com"
453   >&lt;jc@irbs.com&gt;</ulink>,
454
455 David Champion <ulink URL="mailto:dgc@uchicago.edu"
456   >&lt;dgc@uchicago.edu</ulink>,
457
458 Brendan Cully <ulink URL="mailto:brendan@kublai.com"
459   >&lt;brendan@kublai.com&gt;</ulink>,
460
461 Liviu Daia <ulink URL="mailto:daia@stoilow.imar.ro"
462   >&lt;daia@stoilow.imar.ro&gt;</ulink>,
463
464 Thomas E. Dickey <ulink
465   URL="mailto:dickey@herndon4.his.com">&lt;dickey@herndon4.his.com&gt;</ulink>,
466
467 David DeSimone <ulink URL="mailto:fox@convex.hp.com"
468   >&lt;fox@convex.hp.com&gt;</ulink>,
469
470 Nickolay N. Dudorov <ulink URL="mailto:nnd@wint.itfs.nsk.su"
471   >&lt;nnd@wint.itfs.nsk.su&gt;</ulink>,
472
473 Ruslan Ermilov <ulink
474   URL="mailto:ru@freebsd.org">&lt;ru@freebsd.org&gt;</ulink>,
475
476 Edmund Grimley Evans <ulink
477   URL="mailto:edmundo@rano.org">&lt;edmundo@rano.org</ulink>,
478
479 Michael Finken <ulink
480   URL="mailto:finken@conware.de">&lt;finken@conware.de&gt;</ulink>,
481
482 Sven Guckes <ulink
483   URL="mailto:guckes@math.fu-berlin.de">&lt;guckes@math.fu-berlin.de&gt;</ulink>,
484
485 Lars Hecking <ulink URL="mailto:lhecking@nmrc.ie"
486   >&lt;lhecking@nmrc.ie&gt;</ulink>,
487
488 Mark Holloman <ulink
489   URL="mailto:holloman@nando.net">&lt;holloman@nando.net&gt;</ulink>,
490
491 Andreas Holzmann <ulink
492   URL="mailto:holzmann@fmi.uni-passau.de">&lt;holzmann@fmi.uni-passau.de&gt;</ulink>,
493
494 Marco d'Itri <ulink
495   URL="mailto:md@linux.it">&lt;md@linux.it&gt;</ulink>,
496
497 Bj&ouml;rn Jacke <ulink
498   URL="mailto:bjacke@suse.com">&lt;bjacke@suse.com&gt;</ulink>,
499
500 Byrial Jensen <ulink
501   URL="mailto:byrial@image.dk">&lt;byrial@image.dk&gt;</ulink>,
502
503 David Jeske <ulink
504   URL="mailto:jeske@igcom.net">&lt;jeske@igcom.net&gt;</ulink>,
505
506 Christophe Kalt <ulink URL="mailto:kalt@hugo.int-evry.fr"
507   >&lt;kalt@hugo.int-evry.fr&gt;</ulink>,
508
509 Tommi Komulainen <ulink
510   URL="mailto:Tommi.Komulainen@iki.fi">&lt;Tommi.Komulainen@iki.fi&gt;</ulink>,
511
512 Felix von Leitner (a.k.a ``Fefe'') <ulink
513   URL="mailto:leitner@math.fu-berlin.de">&lt;leitner@math.fu-berlin.de&gt;</ulink>,
514
515 Brandon Long <ulink
516   URL="mailto:blong@fiction.net">&lt;blong@fiction.net&gt;</ulink>,
517
518 Jimmy M&auml;kel&auml; <ulink
519   URL="mailto:jmy@flashback.net">&lt;jmy@flashback.net&gt;</ulink>,
520
521 Lars Marowsky-Bree <ulink
522   URL="mailto:lmb@pointer.in-minden.de">&lt;lmb@pointer.in-minden.de&gt;</ulink>,
523
524 Thomas ``Mike'' Michlmayr <ulink
525   URL="mailto:mike@cosy.sbg.ac.at">&lt;mike@cosy.sbg.ac.at&gt;</ulink>,
526
527 Andrew W. Nosenko <ulink
528 URL="mailto:awn@bcs.zp.ua">&lt;awn@bcs.zp.ua&gt;</ulink>,
529
530 David O'Brien <ulink
531   URL="mailto:obrien@Nuxi.cs.ucdavis.edu">&lt;obrien@Nuxi.cs.ucdavis.edu&gt;</ulink>,
532
533 Clint Olsen <ulink URL="mailto:olsenc@ichips.intel.com"
534   >&lt;olsenc@ichips.intel.com&gt;</ulink>,
535
536 Park Myeong Seok <ulink URL="mailto:pms@romance.kaist.ac.kr"
537   >&lt;pms@romance.kaist.ac.kr&gt;</ulink>,
538
539 Thomas Parmelan <ulink URL="mailto:tom@ankh.fr.eu.org"
540   >&lt;tom@ankh.fr.eu.org&gt;</ulink>,
541
542 Ollivier Robert <ulink URL="mailto:roberto@keltia.freenix.fr"
543   >&lt;roberto@keltia.freenix.fr&gt;</ulink>,
544
545 Thomas Roessler <ulink URL="mailto:roessler@does-not-exist.org"
546   >&lt;roessler@does-not-exist.org&gt;</ulink>,
547
548 Roland Rosenfeld <ulink URL="mailto:roland@spinnaker.de"
549   >&lt;roland@spinnaker.de&gt;</ulink>,
550
551 TAKIZAWA Takashi <ulink URL="mailto:taki@luna.email.ne.jp"
552   >&lt;taki@luna.email.ne.jp&gt;</ulink>,
553
554 Allain Thivillon <ulink URL="mailto:Allain.Thivillon@alma.fr"
555   >&lt;Allain.Thivillon@alma.fr&gt;</ulink>
556
557 Gero Treuner <ulink URL="mailto:gero@faveve.uni-stuttgart.de"
558   >&lt;gero@faveve.uni-stuttgart.de&gt;</ulink>,
559
560 Vsevolod Volkov <ulink URL="mailto:vvv@lucky.net"
561   >&lt;vvv@lucky.net&gt;</ulink>,
562
563 Ken Weinert <ulink URL="mailto:kenw@ihs.com"
564   >&lt;kenw@ihs.com&gt;</ulink>
565
566 </para>
567
568 <para>
569 Mutt-ng is developed by the following people:
570 </para>
571
572 <para> Andreas Krennmair <ulink URL="mailto:ak@synflood.at"
573 >&lt;ak@synflood.at&gt;</ulink>,
574
575 Nico Golde <ulink URL="mailto:nico@ngolde.de"
576 >&lt;nico@ngolde.de&gt;</ulink>,
577
578 Rocco Rutte <ulink URL="mailto:pdmef@cs.tu-berlin.de"
579 >&lt;pdmef@cs.tu-berlin.de&gt;</ulink>
580 </para>
581
582 <para> The following people have been very helpful to the development of
583 Mutt-ng: </para>
584
585 <para> Christian Gall <ulink URL="mailto:cg@cgall.de"
586 >&lt;cg@cgall.de&gt;</ulink>,
587
588 Iain Lea <ulink URL="mailto:iain@bricbrac.de"
589 >&lt;iain@bricbrac.de&gt;</ulink>,
590
591 Andreas Kneib <ulink URL="mailto:akneib@gmx.net"
592 >&lt;akneib@gmx.net&gt;</ulink>,
593
594 Carsten Schoelzki <ulink URL="mailto:cjs@weisshuhn.de"
595 >&lt;cjs@weisshuhn.de&gt;</ulink>,
596
597 Elimar Riesebieter <ulink URL="mailto:riesebie@lxtec.de"
598 >&lt;riesebie@lxtec.de&gt;</ulink>
599 </para>
600
601 </sect1>
602
603 </chapter>
604
605 </book>