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