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 id="functions-generic">
  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 id="functions-index">
  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           not bound   jump to the next new message
 114             next-new-then-unread     TAB   jump to the next new or unread message
 115             next-subthread         ESC n   jump to the next subthread
 116             next-thread               ^N   jump to the next thread
 117             next-undeleted             j   move to the next undeleted message
 118             next-unread        not bound   jump to the next unread message
 119             parent-message             P   jump to parent message in thread
 120             pipe-message               |   pipe message/attachment to a shell
 121             command
 122             previous-new       not bound   jump to the previous new message
 123             previous-new-then-unread
 124                                  ESC TAB   jump to the previous new or unread message
 125
 126             previous-page              Z   move to the previous page
 127             previous-subthread     ESC p   jump to previous subthread
 128             previous-thread           ^P   jump to previous thread
 129             previous-undeleted         k   move to the last undelete message
 130             previous-unread    not bound   jump to the previous unread message
 131             print-message              p   print the current entry
 132             query                      Q   query external program for addresses
 133             quit                       q   save changes to mailbox and quit
 134             read-subthread         ESC r   mark the current subthread as read
 135             read-thread               ^R   mark the current thread as read
 136             recall-message             R   recall a postponed message
 137             reply                      r   reply to a message
 138             resend-message         ESC e   resend message and preserve MIME
 139             structure
 140             save-message               s   save message/attachment to a file
 141             set-flag                   w   set a status flag on a message
 142             show-version               V   show the Mutt-ng version number and
 143             date
 144             show-limit             ESC l   show currently active limit pattern,
 145             if any
 146             sort-mailbox               o   sort messages
 147             sort-reverse               O   sort messages in reverse order
 148             sync-mailbox               $   save changes to mailbox
 149             tag-pattern                T   tag messages matching a pattern
 150             tag-thread             ESC t   tag/untag all messages in the
 151             current thread
 152             toggle-new                 N   toggle a message's 'new' flag
 153             toggle-write               %   toggle whether the mailbox will be
 154             rewritten
 155             undelete-message           u   undelete the current entry
 156             undelete-pattern           U   undelete messages matching a pattern
 157             undelete-subthread     ESC u   undelete all messages in subthread
 158             undelete-thread           ^U   undelete all messages in thread
 159             untag-pattern             ^T   untag messages matching a pattern
 160             view-attachments           v   show MIME attachments
 161           </screen>
 162
 163         </para>
 164
 165       </sect2>
 166
 167       <sect2 id="functions-pager">
 168         <title>pager</title>
 169
 170         <para>
 171
 172           <screen>
 173             bottom             not bound   jump to the bottom of the message
 174             bounce-message             b   remail a message to another user
 175             change-folder              c   open a different folder
 176             change-folder-readonly ESC c   open a different folder in read only
 177             mode
 178             check-traditional-pgp  ESC P   check for classic pgp
 179             copy-message               C   copy a message to a file/mailbox
 180             create-alias               a   create an alias from a message
 181             senderdecode-copy            ESC C   decode a message and copy it
 182             to a file/mailbox
 183             decode-save            ESC s   decode a message and save it to a
 184             file/mailbox
 185             delete-message             d   delete the current entry
 186             delete-subthread       ESC d   delete all messages in subthread
 187             delete-thread             ^D   delete all messages in thread
 188             display-address            @   display full address of sender
 189             display-toggle-weed        h   display message and toggle header
 190             weeding
 191             edit                       e   edit the current message
 192             edit-type                 ^E   edit the current message's
 193             Content-Type
 194             enter-command              :   enter a muttngrc command
 195             exit                       i   return to the main-menu
 196             extract-keys              ^K   extract PGP public keys
 197             flag-message               F   toggle a message's 'important' flag
 198             forget-passphrase         ^F   wipe PGP passphrase from memory
 199             forward-message            f   forward a message with comments
 200             group-reply                g   reply to all recipients
 201             half-up            not bound   move up one-half page
 202             half-down          not bound   move down one-half page
 203             help                       ?   this screen
 204             list-reply                 L   reply to specified mailing list
 205             mail                       m   compose a new mail message
 206             mail-key               ESC k   mail a PGP public key
 207             mark-as-new                N   toggle a message's 'new' flag
 208             next-line                RET   scroll down one line
 209             next-entry                 J   move to the next entry
 210             next-new           not bound   jump to the next new message
 211             next-new-then-unread     TAB   jump to the next new or unread message
 212             next-page                      move to the next page
 213             next-subthread         ESC n   jump to the next subthread
 214             next-thread               ^N   jump to the next thread
 215             next-undeleted             j   move to the next undeleted message
 216             next-unread        not bound   jump to the next unread message
 217             parent-message             P   jump to parent message in thread
 218             pipe-message               |   pipe message/attachment to a shell
 219             command
 220             previous-line      BackSpace   scroll up one line
 221             previous-entry             K   move to the previous entry
 222             previous-new       not bound   jump to the previous new message
 223             previous-new-then-unread
 224                                not bound   jump to the previous new or unread message
 225             previous-page              -   move to the previous page
 226             previous-subthread     ESC p   jump to previous subthread
 227             previous-thread           ^P   jump to previous thread
 228             previous-undeleted         k   move to the last undelete message
 229             previous-unread    not bound   jump to the previous unread message
 230             print-message              p   print the current entry
 231             quit                       Q   save changes to mailbox and quit
 232             read-subthread         ESC r   mark the current subthread as read
 233             read-thread               ^R   mark the current thread as read
 234             recall-message             R   recall a postponed message
 235             redraw-screen             ^L   clear and redraw the screen
 236             reply                      r   reply to a message
 237             save-message               s   save message/attachment to a file
 238             search                     /   search for a regular expression
 239             search-next                n   search for next match
 240             search-opposite    not bound   search for next match in opposite
 241             direction
 242             search-reverse         ESC /   search backwards for a regular
 243             expression
 244             search-toggle              \   toggle search pattern coloring
 245             shell-escape               !   invoke a command in a subshell
 246             show-version               V   show the Mutt-ng version number and
 247             date
 248             skip-quoted                S   skip beyond quoted text
 249             sync-mailbox               $   save changes to mailbox
 250             tag-message                t   tag a message
 251             toggle-quoted              T   toggle display of quoted text
 252             top                        ^   jump to the top of the message
 253             undelete-message           u   undelete the current entry
 254             undelete-subthread     ESC u   undelete all messages in subthread
 255             undelete-thread           ^U   undelete all messages in thread
 256             view-attachments           v   show MIME attachments
 257           </screen>
 258
 259         </para>
 260
 261       </sect2>
 262
 263       <sect2 id="functions-alias">
 264         <title>alias</title>
 265
 266         <para>
 267
 268           <screen>
 269             search                     /   search for a regular expression
 270             search-next                n   search for next match
 271             search-reverse         ESC /   search backwards for a regular
 272             expression
 273           </screen>
 274
 275         </para>
 276
 277       </sect2>
 278
 279       <sect2 id="functions-query">
 280         <title>query</title>
 281
 282         <para>
 283
 284           <screen>
 285             create-alias               a   create an alias from a message
 286             sendermail                       m   compose a new mail message
 287             query                      Q   query external program for addresses
 288             query-append               A   append new query results to current
 289             results
 290             search                     /   search for a regular expression
 291             search-next                n   search for next match
 292             search-opposite    not bound   search for next match in opposite
 293             direction
 294             search-reverse         ESC /   search backwards for a regular
 295             expression
 296           </screen>
 297
 298         </para>
 299
 300       </sect2>
 301
 302       <sect2 id="functions-attach">
 303         <title>attach</title>
 304
 305         <para>
 306
 307           <screen>
 308             bounce-message             b   remail a message to another user
 309             collapse-parts             v   toggle display of subparts
 310             delete-entry               d   delete the current entry
 311             display-toggle-weed        h   display message and toggle header
 312             weeding
 313             edit-type                 ^E   edit the current entry's
 314             Content-Typeextract-keys              ^K   extract PGP public keys
 315             forward-message            f   forward a message with comments
 316             group-reply                g   reply to all recipients
 317             list-reply                 L   reply to specified mailing list
 318             pipe-entry                 |   pipe message/attachment to a shell
 319             command
 320             print-entry                p   print the current entry
 321             reply                      r   reply to a message
 322             resend-message         ESC e   resend message and preserve MIME
 323             structure
 324             save-entry                 s   save message/attachment to a file
 325             undelete-entry             u   undelete the current entry
 326             view-attach              RET   view attachment using mailcap entry
 327             if necessary
 328             view-mailcap               m   force viewing of attachment using
 329             mailcap
 330             view-text                  T   view attachment as text
 331           </screen>
 332
 333         </para>
 334
 335       </sect2>
 336
 337       <sect2 id="functions-compose">
 338         <title>compose</title>
 339
 340         <para>
 341
 342           <screen>
 343             attach-file                a   attach a file(s) to this message
 344             attach-message             A   attach message(s) to this message
 345             attach-key             ESC k   attach a PGP public key
 346             copy-file                  C   save message/attachment to a file
 347             detach-file                D   delete the current entry
 348             display-toggle-weed        h   display message and toggle header
 349             weeding
 350             edit-bcc                   b   edit the BCC list
 351             edit-cc                    c   edit the CC list
 352             edit-description           d   edit attachment description
 353             edit-encoding             ^E   edit attachment transfer-encoding
 354             edit-fcc                   f   enter a file to save a copy of this
 355             message in
 356             edit-from              ESC f   edit the from: field
 357             edit-file               ^X e   edit the file to be attached
 358             edit-headers               E   edit the message with headers
 359             edit                       e   edit the message
 360             edit-mime                  m   edit attachment using mailcap entry
 361             edit-reply-to              r   edit the Reply-To field
 362             edit-subject               s   edit the subject of this message
 363             edit-to                    t   edit the TO list
 364             edit-type                 ^T   edit attachment type
 365             filter-entry               F   filter attachment through a shell
 366             command
 367             forget-passphrase         ^F   wipe PGP passphrase from memory
 368             ispell                     i   run ispell on the message
 369             new-mime                   n   compose new attachment using mailcap
 370             entry
 371             pgp-menu                   p   show PGP options
 372             pipe-entry                 |   pipe message/attachment to a shell
 373             command
 374             postpone-message           P   save this message to send later
 375             print-entry                l   print the current entry
 376             rename-file                R   rename/move an attached file
 377             send-message               y   send the message
 378             toggle-unlink              u   toggle whether to delete file after
 379             sending it
 380             view-attach              RET   view attachment using mailcap entry
 381             if necessary
 382             write-fcc              w   write the message to a folder
 383           </screen>
 384
 385         </para>
 386
 387       </sect2>
 388
 389       <sect2 id="functions-postpone">
 390         <title>postpone</title>
 391
 392         <para>
 393
 394           <screen>
 395             delete-entry               d   delete the current entry
 396             undelete-entry             u   undelete the current entry
 397           </screen>
 398
 399         </para>
 400
 401       </sect2>
 402
 403       <sect2 id="functions-browser">
 404         <title>browser</title>
 405
 406         <para>
 407
 408           <screen>
 409             change-dir                 c   change directories
 410             check-new                TAB   check mailboxes for new mail
 411             enter-mask                 m   enter a file mask
 412             search                     /   search for a regular expression
 413             search-next                n   search for next match
 414             search-reverse         ESC /   search backwards for a regular
 415             expression
 416             select-new                 N   select a new file in this directory
 417             sort                       o   sort messages
 418             sort-reverse               O   sort messages in reverse order
 419             toggle-mailboxes         TAB   toggle whether to browse mailboxes
 420             or all files
 421             view-file              SPACE   view file
 422             subscribe                  s   subscribe to current mailbox (IMAP
 423             Only)
 424             unsubscribe                u   unsubscribe to current mailbox (IMAP
 425             Only)
 426             toggle-subscribed          T   toggle view all/subscribed mailboxes
 427             (IMAP Only)
 428           </screen>
 429
 430         </para>
 431
 432       </sect2>
 433
 434       <sect2 id="functions-crypto">
 435         <title>pgp</title>
 436
 437         <para>
 438
 439           <screen>
 440             view-name                  %   view the key's user id
 441             verify-key                 c   verify a PGP public key
 442           </screen>
 443
 444         </para>
 445
 446       </sect2>
 447
 448       <sect2 id="functions-editor">
 449         <title>editor</title>
 450
 451         <para>
 452
 453           <screen>
 454             backspace          BackSpace   delete the char in front of the
 455             cursor
 456             backward-char             ^B   move the cursor one character to the
 457             left
 458             backward-word          ESC b   move the cursor to the previous word
 459             bol                       ^A   jump to the beginning of the line
 460             buffy-cycle            Space   cycle among incoming mailboxes
 461             capitalize-word        ESC c   uppercase the first character in the
 462             word
 463             complete                 TAB   complete filename or alias
 464             complete-query            ^T   complete address with query
 465             delete-char               ^D   delete the char under the cursor
 466             downcase-word          ESC l   lowercase all characters in current
 467             word
 468             eol                       ^E   jump to the end of the line
 469             forward-char              ^F   move the cursor one character to the
 470             right
 471             forward-word           ESC f   move the cursor to the next word
 472             history-down       not bound   scroll down through the history list
 473             history-up         not bound   scroll up through the history list
 474             kill-eol                  ^K   delete chars from cursor to end of
 475             line
 476             kill-eow               ESC d   delete chars from cursor to end of
 477             word
 478             kill-line                 ^U   delete all chars on the line
 479             kill-word                 ^W   delete the word in front of the
 480             cursor
 481             quote-char                ^V   quote the next typed key
 482             transpose-chars    not bound   transpose character under cursor
 483             with previous
 484             upcase-word            ESC u   uppercase all characters in current
 485             word
 486           </screen>
 487
 488         </para>
 489
 490       </sect2>
 491
 492     </sect1>
 493
 494   </chapter>
 495
 496   <appendix/>
 497
 498   <chapter id="acknowledgments">
 499     <title>Acknowledgments</title>
 500
 501     <para>
 502         Kari Hurtta <email>kari.hurtta@fmi.fi</email> co-developed the
 503       original MIME
 504       >parsing code back in the ELM-ME days.
 505     </para>
 506
 507     <para> The following people have been very helpful to the development of
 508       Mutt (sorted by surnames):
 509     </para>
 510
 511     <para>
 512       <itemizedlist>
 513         <listitem>
 514           Vikas Agnihotri <email>vikasa@writeme.com</email>
 515         </listitem>
 516         <listitem>
 517           Francois Berjon <email> Francois.Berjon@aar.alcatel-alsthom.fr</email>
 518         </listitem>
 519         <listitem>
 520           Aric Blumer <email>aric@fore.com</email>, John Capo <email>
 521             jc@irbs.com
 522           </email>
 523         </listitem>
 524         <listitem>
 525           David Champion <email>dgc@uchicago.edu</email>
 526         </listitem>
 527         <listitem>
 528           Brendan Cully <email>brendan@kublai.com</email>
 529         </listitem>
 530         <listitem>
 531           Liviu Daia <email>daia@stoilow.imar.ro</email>
 532         </listitem>
 533         <listitem>
 534           Thomas E. Dickey <email>dickey@herndon4.his.com</email>
 535         </listitem>
 536         <listitem>
 537           David DeSimone <email>fox@convex.hp.com</email>
 538         </listitem>
 539         <listitem>
 540           Nickolay N. Dudorov <email>nnd@wint.itfs.nsk.su</email>
 541         </listitem>
 542         <listitem>
 543           Ruslan Ermilov <email>ru@freebsd.org</email>
 544         </listitem>
 545         <listitem>
 546           Edmund Grimley Evans <email>edmundo@rano.org</email>
 547         </listitem>
 548         <listitem>
 549           Michael Finken <email>finken@conware.de</email>
 550         </listitem>
 551         <listitem>
 552           Sven Guckes <email>guckes@math.fu-berlin.de</email>
 553         </listitem>
 554         <listitem>
 555           Lars Hecking <email>lhecking@nmrc.ie</email>
 556         </listitem>
 557         <listitem>
 558           Mark Holloman <email>holloman@nando.net</email>
 559         </listitem>
 560         <listitem>
 561           Andreas Holzmann <email>holzmann@fmi.uni-passau.de</email>
 562         </listitem>
 563         <listitem>
 564           Marco d'Itri <email>md@linux.it</email>
 565         </listitem>
 566         <listitem>
 567           Björn Jacke <email>bjacke@suse.com</email>
 568         </listitem>
 569         <listitem>
 570           Byrial Jensen <email>byrial@image.dk</email>
 571         </listitem>
 572         <listitem>
 573           David Jeske <email>jeske@igcom.net</email>
 574         </listitem>
 575         <listitem>
 576           Christophe Kalt <email>kalt@hugo.int-evry.fr</email>
 577         </listitem>
 578         <listitem>
 579           Tommi Komulainen <email>Tommi.Komulainen@iki.fi</email>
 580         </listitem>
 581         <listitem>
 582           Felix von Leitner (a.k.a ``Fefe'') <email>
 583             leitner@math.fu-berlin.de
 584           </email>
 585         </listitem>
 586         <listitem>
 587           Brandon Long <email>blong@fiction.net</email>
 588         </listitem>
 589         <listitem>
 590           Jimmy Mäkeä <email>jmy@flashback.net</email>
 591         </listitem>
 592         <listitem>
 593           Lars Marowsky-Bree <email>lmb@pointer.in-minden.de</email>
 594         </listitem>
 595         <listitem>
 596           Thomas ``Mike'' Michlmayr <email>mike@cosy.sbg.ac.at</email>
 597         </listitem>
 598         <listitem>
 599           Andrew W. Nosenko <email>awn@bcs.zp.ua</email>
 600         </listitem>
 601         <listitem>
 602           David O'Brien <email>obrien@Nuxi.cs.ucdavis.edu</email>
 603         </listitem>
 604         <listitem>
 605           Clint Olsen <email>olsenc@ichips.intel.com</email>
 606         </listitem>
 607         <listitem>
 608           Park Myeong Seok <email>pms@romance.kaist.ac.kr</email>
 609         </listitem>
 610         <listitem>
 611           Thomas Parmelan <email>tom@ankh.fr.eu.org</email>
 612         </listitem>
 613         <listitem>
 614           Ollivier Robert <email>roberto@keltia.freenix.fr</email>
 615         </listitem>
 616         <listitem>
 617           Thomas Roessler <email>roessler@does-not-exist.org</email>
 618         </listitem>
 619         <listitem>
 620           Roland Rosenfeld <email>roland@spinnaker.de</email>
 621         </listitem>
 622         <listitem>
 623           TAKIZAWA Takashi <email>taki@luna.email.ne.jp</email>
 624         </listitem>
 625         <listitem>
 626           Allain Thivillon <email>Allain.Thivillon@alma.fr</email>
 627         </listitem>
 628         <listitem>
 629           Gero Treuner <email>gero@faveve.uni-stuttgart.de</email>
 630         </listitem>
 631         <listitem>
 632           Vsevolod Volkov <email>vvv@lucky.net</email>
 633         </listitem>
 634         <listitem>
 635           Ken Weinert <email>kenw@ihs.com</email>
 636         </listitem>
 637         </itemizedlist>
 638       </para>
 639
 640       <para>
 641         Mutt-ng is developed by the following people:
 642       </para>
 643
 644       <para>
 645         <itemizedlist>
 646           <listitem>
 647             Andreas Krennmair <email>ak@synflood.at</email>
 648           </listitem>
 649           <listitem>
 650             Nico Golde <email>nico@ngolde.de</email>
 651           </listitem>
 652           <listitem>
 653             Rocco Rutte <email>pdmef@cs.tu-berlin.de</email>
 654           </listitem>
 655         </itemizedlist>
 656       </para>
 657
 658       <para>
 659         The following people have been very helpful to the
 660         development of Mutt-ng (sorted by surnames):
 661       </para>
 662
 663       <para>
 664         <itemizedlist>
 665           <listitem>
 666             Christian Gall <email>cg@cgall.de</email>
 667           </listitem>
 668           <listitem>
 669             Iain Lea <email>iain@bricbrac.de</email>
 670           </listitem>
 671           <listitem>
 672             Andreas Kneib <email>akneib@gmx.net</email>
 673           </listitem>
 674           <listitem>
 675             Felix Meinhold <email>felix.meinhold@gmx.net</email>
 676           </listitem>
 677           <listitem>
 678             Carsten Schoelzki <email>cjs@weisshuhn.de</email>
 679           </listitem>
 680           <listitem>
 681             Elimar Riesebieter <email>riesebie@lxtec.de</email>
 682           </listitem>
 683         </itemizedlist>
 684       </para>
 685
 686     </chapter>
 687
 688     <chapter id="hacking-documentation">
 689       <title>Hacking Documentation</title>
 690
 691       <para>
 692         This manual is written in XML and transformed via a XSLT
 693         stylesheet into valid DocBook/XML to be again transformed via a
 694         XSLT stylesheet into the final formats.
 695       </para>
 696
 697       <para>
 698         This two pass processing is required to keep the file size low
 699         and to sanitize use, i.e. drastically lower the typing
 700         overhead.
 701       </para>
 702
 703       <para>
 704         To achieve the latter, the sources come with a file called
 705         <literal>muttng-manual.xsl</literal> introducing the
 706         <literal>muttng-doc</literal> namespace which offers the following
 707         tags to be used (<emphasis>note: this is far from being
 708           complete, any help towards consistency is <emphasis
 709             role="bold">highly</emphasis> appreciated</emphasis>).
 710       </para>
 711
 712       <para>
 713         <variablelist>
 714           <varlistentry>
 715             <term><literal>&lt;muttng-doc:man name="" [sect=""]/&gt;</literal></term>
 716             <listitem><para>
 717                 <emphasis>References to manual pages.</emphasis> If the
 718                 <literal>sect</literal> parameter is omitted, it'll
 719                 be 1 for the commands section. There's no auto-indexing yet.
 720             </para></listitem>
 721           </varlistentry>
 722           <varlistentry>
 723             <term><literal>&lt;muttng-doc:envvar name=""/&gt;</literal></term>
 724             <listitem><para>
 725                 <emphasis>References to environment
 726                   variables.</emphasis> The <literal>name</literal>
 727                 parameter must contain upper-case letters only without
 728                 the dollar sign as it'll be added automatically.
 729                 Auto-indexing under <emphasis>Environment
 730                   Variables</emphasis> is done.
 731             </para></listitem>
 732           </varlistentry>
 733           <varlistentry>
 734             <term><literal>&lt;muttng-doc:hook name=""/&gt;</literal></term>
 735             <listitem><para>
 736                 <emphasis>References to hooks.</emphasis> The string
 737                 <literal>-hook</literal> will be added automatically to
 738                 the value given in the <literal>name</literal>
 739                 parameter. All entries will be auto-indexed under
 740                 <emphasis>Hooks</emphasis>.
 741             </para></listitem>
 742           </varlistentry>
 743           <varlistentry>
 744             <term><literal>&lt;muttng-doc:command name=""/&gt;</literal></term>
 745             <listitem><para>
 746                 <emphasis>References to configuration
 747                   commands.</emphasis> The name is given via the
 748                 <literal>name</literal> parameter and will be
 749                 auto-indexed under <emphasis>Configuration
 750                   Commands</emphasis>.
 751             </para></listitem>
 752           </varlistentry>
 753           <varlistentry>
 754             <term><literal>&lt;muttng-doc:pattern name=""/&gt;</literal></term>
 755             <listitem><para>
 756                 <emphasis>References to patterns.</emphasis> The
 757                 <literal>name</literal> parameter must only contain the
 758                 letter/symbol for the pattern as the tilde symbol/equal
 759                 sign will be added automatically. Auto-indexing is done
 760                 under <emphasis>Patterns</emphasis>.
 761             </para></listitem>
 762           </varlistentry>
 763           <varlistentry>
 764             <term><literal>&lt;muttng-doc:funcdef name="" key=""/&gt;</literal></term>
 765             <listitem><para>
 766                 <emphasis>Defining a command.</emphasis>. It's used to
 767                 define a command with the name given in the
 768                 <literal>name</literal> parameter and a default key
 769                 binding given via <literal>key</literal>. The string
 770                 will be automatically enclosed in
 771                 <literal>&lt;&gt;</literal>. Auto-indexing is done under
 772                 <emphasis>Functions</emphasis>. Also an anchor with id
 773                 <literal>func-[name]</literal> will be added with
 774                 <literal>[name]</literal> being the value of the
 775                 <literal>name</literal> parameter.
 776             </para></listitem>
 777           </varlistentry>
 778           <varlistentry>
 779             <term><literal>&lt;muttng-doc:funcref name=""/&gt;</literal></term>
 780             <listitem><para>
 781                 <emphasis>References to functions.</emphasis>. This is
 782                 practically the same as the above except that there's no
 783                 anchor defined.
 784             </para></listitem>
 785           </varlistentry>
 786           <varlistentry>
 787             <term><literal>&lt;muttng-doc:vardef name="" id=""/&gt;</literal></term>
 788             <listitem><para>
 789                 <emphasis>Defining a variable.</emphasis> This is to be
 790                 used by <literal>makedoc</literal> only to define a
 791                 command with a given name and XML-normalized link given
 792                 via <literal>id</literal>. Auto-indexing is done under
 793                 <emphasis>Configuration Variables</emphasis>. The
 794                 <literal>name</literal> parameter's value will be
 795                 prefixed with a dollar sign as for environment
 796                 variables.
 797             </para></listitem>
 798           </varlistentry>
 799           <varlistentry>
 800             <term><literal>&lt;muttng-doc:varref name="" link=""/&gt;</literal></term>
 801             <listitem><para>
 802                 <emphasis>References to variables.</emphasis> This
 803                 practically is the same as above except that the text
 804                 inbetween won't be wrapped within a
 805                 <literal>&lt;sect1&gt;</literal> tag. Auto-indexing is
 806                 the same as for the above. This one is intended for
 807                 manual use.
 808             </para></listitem>
 809           </varlistentry>
 810         </variablelist>
 811       </para>
 812
 813     </chapter>
 814
 815     <index/>
 816
 817   </book>