+++ /dev/null
-<!-- vim:ft=xml
--->
-
- </sect1>
-
- <sect1 id="functions">
- <title>Functions</title>
-
- <para>
- The following is the list of available functions listed by the mapping
- in which they are available. The default key setting is given, and an
- explanation of what the function does. The key bindings of these
- functions can be changed with the <link linkend="bind">bind</link>
- command.
- </para>
-
- <sect2 id="functions-generic">
- <title>generic</title>
-
- <para>
- The <emphasis>generic</emphasis> menu is not a real menu, but
- specifies common functions
- (such as movement) available in all menus except for <emphasis>pager</emphasis> and
- <emphasis>editor</emphasis>. Changing settings for this menu will
- affect the default
- bindings for all menus (except as noted).
- </para>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Generic Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="bottom-page"/></entry>
- <entry><madmutt-doc:key>L</madmutt-doc:key></entry>
- <entry>move to the bottom of the page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="current-bottom"/></entry>
- <entry></entry>
- <entry>move current entry to bottom of page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="current-middle"/></entry>
- <entry></entry>
- <entry>move current entry to middle of page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="current-top"/></entry>
- <entry></entry>
- <entry>move current entry to top of page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="enter-command"/></entry>
- <entry><madmutt-doc:key>:</madmutt-doc:key></entry>
- <entry>enter a madmuttrc command</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="exit"/></entry>
- <entry><madmutt-doc:key>q</madmutt-doc:key></entry>
- <entry>exit this menu</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="first-entry"/></entry>
- <entry><madmutt-doc:key>=</madmutt-doc:key></entry>
- <entry>move to the first entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="half-down"/></entry>
- <entry><madmutt-doc:key>]</madmutt-doc:key></entry>
- <entry>scroll down 1/2 page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="half-up"/></entry>
- <entry><madmutt-doc:key>[</madmutt-doc:key></entry>
- <entry>scroll up 1/2 page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="help"/></entry>
- <entry><madmutt-doc:key>?</madmutt-doc:key></entry>
- <entry>this screen</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="jump"/></entry>
- <entry><madmutt-doc:key>number</madmutt-doc:key></entry>
- <entry>jump to an index number</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="last-entry"/></entry>
- <entry><madmutt-doc:key>*</madmutt-doc:key></entry>
- <entry>move to the last entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="middle-page"/></entry>
- <entry><madmutt-doc:key>M</madmutt-doc:key></entry>
- <entry>move to the middle of the page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-entry"/></entry>
- <entry><madmutt-doc:key>j</madmutt-doc:key></entry>
- <entry>move to the next entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-line"/></entry>
- <entry><madmutt-doc:key>></madmutt-doc:key></entry>
- <entry>scroll down one line</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-page"/></entry>
- <entry><madmutt-doc:key>z</madmutt-doc:key></entry>
- <entry>move to the next page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-entry"/></entry>
- <entry><madmutt-doc:key>k</madmutt-doc:key></entry>
- <entry>move to the previous entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-line"/></entry>
- <entry><madmutt-doc:key>></madmutt-doc:key></entry>
- <entry>scroll up one line</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-page"/></entry>
- <entry><madmutt-doc:key>Z</madmutt-doc:key></entry>
- <entry>move to the previous page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="rebuild-cache"/></entry>
- <entry></entry>
- <entry>cycle through all defined mailboxes to rebuild all header caches</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="refresh"/></entry>
- <entry><madmutt-doc:key mod="C">L</madmutt-doc:key></entry>
- <entry>clear and redraw the screen</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search"/></entry>
- <entry><madmutt-doc:key>/</madmutt-doc:key></entry>
- <entry>search for a regular expression</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-next"/></entry>
- <entry><madmutt-doc:key>n</madmutt-doc:key></entry>
- <entry>search for next match</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-opposite"/></entry>
- <entry></entry>
- <entry>search for next match in opposite direction</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-reverse"/></entry>
- <entry><madmutt-doc:key mod="E">/</madmutt-doc:key></entry>
- <entry>search backwards for a regular expression</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="select-entry"/></entry>
- <entry><madmutt-doc:key>Return</madmutt-doc:key></entry>
- <entry>select the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="shell-escape"/></entry>
- <entry><madmutt-doc:key>!</madmutt-doc:key></entry>
- <entry>run a program in a subshell</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="tag-entry"/></entry>
- <entry><madmutt-doc:key>t</madmutt-doc:key></entry>
- <entry>toggle the tag on the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="tag-prefix"/></entry>
- <entry><madmutt-doc:key>;</madmutt-doc:key></entry>
- <entry>apply next command to tagged entries</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="tag-prefix-cond"/></entry>
- <entry></entry>
- <entry>apply next function ONLY to tagged messages</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="top-page"/></entry>
- <entry><madmutt-doc:key>H</madmutt-doc:key></entry>
- <entry>move to the top of the page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="what-key"/></entry>
- <entry></entry>
- <entry>display the keycode for a key press</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-index">
- <title>index</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Index Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="bounce-message"/></entry>
- <entry><madmutt-doc:key>b</madmutt-doc:key></entry>
- <entry>remail a message to another user</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="change-folder"/></entry>
- <entry><madmutt-doc:key>c</madmutt-doc:key></entry>
- <entry>open a different folder</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="change-folder-readonly"/></entry>
- <entry><madmutt-doc:key mod="E">c</madmutt-doc:key></entry>
- <entry>open a different folder in read only mode</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="check-traditional-pgp"/></entry>
- <entry><madmutt-doc:key mod="E">P</madmutt-doc:key></entry>
- <entry>check for classic pgp</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="clear-flag"/></entry>
- <entry><madmutt-doc:key>W</madmutt-doc:key></entry>
- <entry>clear a status flag from a message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="copy-message"/></entry>
- <entry><madmutt-doc:key>C</madmutt-doc:key></entry>
- <entry>copy a message to a file/mailbox</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="create-alias"/></entry>
- <entry><madmutt-doc:key>a</madmutt-doc:key></entry>
- <entry>create an alias from a message sender</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="decode-copy"/></entry>
- <entry><madmutt-doc:key mod="E">C</madmutt-doc:key></entry>
- <entry>decode a message and copy it to a file/mailbox</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="decode-save"/></entry>
- <entry><madmutt-doc:key mod="E">s</madmutt-doc:key></entry>
- <entry>decode a message and save it to a file/mailbox</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-message"/></entry>
- <entry><madmutt-doc:key>d</madmutt-doc:key></entry>
- <entry>delete the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-pattern"/></entry>
- <entry><madmutt-doc:key>D</madmutt-doc:key></entry>
- <entry>delete messages matching a pattern</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">d</madmutt-doc:key></entry>
- <entry>delete all messages in subthread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-thread"/></entry>
- <entry><madmutt-doc:key mod="C">D</madmutt-doc:key></entry>
- <entry>delete all messages in thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="display-address"/></entry>
- <entry><madmutt-doc:key>@</madmutt-doc:key></entry>
- <entry>display full address of sender</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="display-toggle-weed"/></entry>
- <entry><madmutt-doc:key>h</madmutt-doc:key></entry>
- <entry>display message and toggle header weeding</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="display-message"/></entry>
- <entry><madmutt-doc:key>Return</madmutt-doc:key></entry>
- <entry>display a message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit"/></entry>
- <entry><madmutt-doc:key>e</madmutt-doc:key></entry>
- <entry>edit the current message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-type"/></entry>
- <entry><madmutt-doc:key mod="C">E</madmutt-doc:key></entry>
- <entry>edit the current message's Content-Type</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="exit"/></entry>
- <entry><madmutt-doc:key>x</madmutt-doc:key></entry>
- <entry>exit without saving changes</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="extract-keys"/></entry>
- <entry><madmutt-doc:key mod="C">K</madmutt-doc:key></entry>
- <entry>extract PGP public keys</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="fetch-mail"/></entry>
- <entry><madmutt-doc:key>G</madmutt-doc:key></entry>
- <entry>retrieve mail from POP server</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="flag-message"/></entry>
- <entry><madmutt-doc:key>F</madmutt-doc:key></entry>
- <entry>toggle a message's 'important' flag</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="forget-passphrase"/></entry>
- <entry><madmutt-doc:key mod="C">F</madmutt-doc:key></entry>
- <entry>wipe PGP passphrase from memory</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="forward-message"/></entry>
- <entry><madmutt-doc:key>f</madmutt-doc:key></entry>
- <entry>forward a message with comments</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="group-reply"/></entry>
- <entry><madmutt-doc:key>g</madmutt-doc:key></entry>
- <entry>reply to all recipients</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="limit"/></entry>
- <entry><madmutt-doc:key>l</madmutt-doc:key></entry>
- <entry>show only messages matching a pattern</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="list-reply"/></entry>
- <entry><madmutt-doc:key>L</madmutt-doc:key></entry>
- <entry>reply to specified mailing list</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="mail"/></entry>
- <entry><madmutt-doc:key>m</madmutt-doc:key></entry>
- <entry>compose a new mail message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="mail-key"/></entry>
- <entry><madmutt-doc:key mod="E">k</madmutt-doc:key></entry>
- <entry>mail a PGP public key</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-new"/></entry>
- <entry></entry>
- <entry>jump to the next new message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-new-then-unread"/></entry>
- <entry><madmutt-doc:key>Tab</madmutt-doc:key></entry>
- <entry>jump to the next new or unread message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">n</madmutt-doc:key></entry>
- <entry>jump to the next subthread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-thread"/></entry>
- <entry><madmutt-doc:key mod="C">N</madmutt-doc:key></entry>
- <entry>jump to the next thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-undeleted"/></entry>
- <entry><madmutt-doc:key>j</madmutt-doc:key></entry>
- <entry>move to the next undeleted message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-unread"/></entry>
- <entry></entry>
- <entry>jump to the next unread message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="parent-message"/></entry>
- <entry><madmutt-doc:key>P</madmutt-doc:key></entry>
- <entry>jump to parent message in thread </entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="pipe-message"/></entry>
- <entry><madmutt-doc:key>|</madmutt-doc:key></entry>
- <entry>pipe message/attachment to a shell command</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-new"/></entry>
- <entry></entry>
- <entry>jump to the previous new message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-new-then-unread"/></entry>
- <entry><madmutt-doc:key mod="E">Tab</madmutt-doc:key></entry>
- <entry>jump to the previous new or unread message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-page"/></entry>
- <entry><madmutt-doc:key>Z</madmutt-doc:key></entry>
- <entry>move to the previous page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">p</madmutt-doc:key></entry>
- <entry>jump to previous subthread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-thread"/></entry>
- <entry><madmutt-doc:key mod="C">P</madmutt-doc:key></entry>
- <entry>jump to previous thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-undeleted"/></entry>
- <entry><madmutt-doc:key>k</madmutt-doc:key></entry>
- <entry>move to the last undelete message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-unread"/></entry>
- <entry></entry>
- <entry>jump to the previous unread message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="print-message"/></entry>
- <entry><madmutt-doc:key>p</madmutt-doc:key></entry>
- <entry>print the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="query"/></entry>
- <entry><madmutt-doc:key>Q</madmutt-doc:key></entry>
- <entry>query external program for addresses</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="quit"/></entry>
- <entry><madmutt-doc:key>q</madmutt-doc:key></entry>
- <entry>save changes to mailbox and quit</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="read-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">r</madmutt-doc:key></entry>
- <entry>mark the current subthread as read</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="read-thread"/></entry>
- <entry><madmutt-doc:key mod="C">R</madmutt-doc:key></entry>
- <entry>mark the current thread as read</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="recall-message"/></entry>
- <entry><madmutt-doc:key>R</madmutt-doc:key></entry>
- <entry>recall a postponed message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="reply"/></entry>
- <entry><madmutt-doc:key>r</madmutt-doc:key></entry>
- <entry>reply to a message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="resend-message"/></entry>
- <entry><madmutt-doc:key mod="E">e</madmutt-doc:key></entry>
- <entry>resend message and preserve MIME structure</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="save-message"/></entry>
- <entry><madmutt-doc:key>s</madmutt-doc:key></entry>
- <entry>save message/attachment to a file</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="set-flag"/></entry>
- <entry><madmutt-doc:key>w</madmutt-doc:key></entry>
- <entry>set a status flag on a message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="show-version"/></entry>
- <entry><madmutt-doc:key>V</madmutt-doc:key></entry>
- <entry>show the Madmutt version number and date</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="show-limit"/></entry>
- <entry><madmutt-doc:key mod="E">l</madmutt-doc:key></entry>
- <entry>show currently active limit pattern, if any</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="sort-mailbox"/></entry>
- <entry><madmutt-doc:key>o</madmutt-doc:key></entry>
- <entry>sort messages</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="sort-reverse"/></entry>
- <entry><madmutt-doc:key>O</madmutt-doc:key></entry>
- <entry>sort messages in reverse order</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="sync-mailbox"/></entry>
- <entry><madmutt-doc:key>$</madmutt-doc:key></entry>
- <entry>save changes to mailbox</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="tag-pattern"/></entry>
- <entry><madmutt-doc:key>T</madmutt-doc:key></entry>
- <entry>tag messages matching a pattern</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="tag-thread"/></entry>
- <entry><madmutt-doc:key mod="E">t</madmutt-doc:key></entry>
- <entry>tag/untag all messages in the current thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="toggle-new"/></entry>
- <entry><madmutt-doc:key>N</madmutt-doc:key></entry>
- <entry>toggle a message's 'new' flag</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="toggle-write"/></entry>
- <entry><madmutt-doc:key>%</madmutt-doc:key></entry>
- <entry>toggle whether the mailbox will be rewritten</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-message"/></entry>
- <entry><madmutt-doc:key>u</madmutt-doc:key></entry>
- <entry>undelete the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-pattern"/></entry>
- <entry><madmutt-doc:key>U</madmutt-doc:key></entry>
- <entry>undelete messages matching a pattern</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">u</madmutt-doc:key></entry>
- <entry>undelete all messages in subthread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-thread"/></entry>
- <entry><madmutt-doc:key mod="C">U</madmutt-doc:key></entry>
- <entry>undelete all messages in thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="untag-pattern"/></entry>
- <entry><madmutt-doc:key mod="C">T</madmutt-doc:key></entry>
- <entry>untag messages matching a pattern</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="view-attachments"/></entry>
- <entry><madmutt-doc:key>v</madmutt-doc:key></entry>
- <entry>show MIME attachments</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-pager">
- <title>pager</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Pager Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="bottom"/></entry>
- <entry></entry>
- <entry>jump to the bottom of the message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="bounce-message"/></entry>
- <entry><madmutt-doc:key>b</madmutt-doc:key></entry>
- <entry>remail a message to another user</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="change-folder"/></entry>
- <entry><madmutt-doc:key>c</madmutt-doc:key></entry>
- <entry>open a different folder</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="change-folder-readonly"/></entry>
- <entry><madmutt-doc:key mod="E">c</madmutt-doc:key></entry>
- <entry>open a different folder in read only mode</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="check-traditional-pgp"/></entry>
- <entry><madmutt-doc:key mod="E">P</madmutt-doc:key></entry>
- <entry>check for classic pgp</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="copy-message"/></entry>
- <entry><madmutt-doc:key>C</madmutt-doc:key></entry>
- <entry>copy a message to a file/mailbox</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="create-alias"/></entry>
- <entry><madmutt-doc:key>a</madmutt-doc:key></entry>
- <entry>create an alias from a message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="senderdecode-copy"/></entry>
- <entry><madmutt-doc:key mod="E">C</madmutt-doc:key></entry>
- <entry>decode a message and copy it to a file/mailbox</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="decode-save"/></entry>
- <entry><madmutt-doc:key mod="E">s</madmutt-doc:key></entry>
- <entry>decode a message and save it to a file/mailbox</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-message"/></entry>
- <entry><madmutt-doc:key>d</madmutt-doc:key></entry>
- <entry>delete the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">d</madmutt-doc:key></entry>
- <entry>delete all messages in subthread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-thread"/></entry>
- <entry><madmutt-doc:key mod="C">D</madmutt-doc:key></entry>
- <entry>delete all messages in thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="display-address"/></entry>
- <entry><madmutt-doc:key>@</madmutt-doc:key></entry>
- <entry>display full address of sender</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="display-toggle-weed"/></entry>
- <entry><madmutt-doc:key>h</madmutt-doc:key></entry>
- <entry>display message and toggle header weeding</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit"/></entry>
- <entry><madmutt-doc:key>e</madmutt-doc:key></entry>
- <entry>edit the current message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-type"/></entry>
- <entry><madmutt-doc:key mod="C">E</madmutt-doc:key></entry>
- <entry>edit the current message's Content-Type</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="enter-command"/></entry>
- <entry><madmutt-doc:key>:</madmutt-doc:key></entry>
- <entry>enter a madmuttrc command</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="exit"/></entry>
- <entry><madmutt-doc:key>i</madmutt-doc:key></entry>
- <entry>return to the main-menu</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="extract-keys"/></entry>
- <entry><madmutt-doc:key mod="C">K</madmutt-doc:key></entry>
- <entry>extract PGP public keys</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="flag-message"/></entry>
- <entry><madmutt-doc:key>F</madmutt-doc:key></entry>
- <entry>toggle a message's 'important' flag</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="forget-passphrase"/></entry>
- <entry><madmutt-doc:key mod="C">F</madmutt-doc:key></entry>
- <entry>wipe PGP passphrase from memory</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="forward-message"/></entry>
- <entry><madmutt-doc:key>f</madmutt-doc:key></entry>
- <entry>forward a message with comments</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="group-reply"/></entry>
- <entry><madmutt-doc:key>g</madmutt-doc:key></entry>
- <entry>reply to all recipients</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="half-up"/></entry>
- <entry></entry>
- <entry>move up one-half page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="half-down"/></entry>
- <entry></entry>
- <entry>move down one-half page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="help"/></entry>
- <entry><madmutt-doc:key>?</madmutt-doc:key></entry>
- <entry>this screen</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="list-reply"/></entry>
- <entry><madmutt-doc:key>L</madmutt-doc:key></entry>
- <entry>reply to specified mailing list</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="mail"/></entry>
- <entry><madmutt-doc:key>m</madmutt-doc:key></entry>
- <entry>compose a new mail message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="mail-key"/></entry>
- <entry><madmutt-doc:key mod="E">k</madmutt-doc:key></entry>
- <entry>mail a PGP public key</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="mark-as-new"/></entry>
- <entry><madmutt-doc:key>N</madmutt-doc:key></entry>
- <entry>toggle a message's 'new' flag</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-line"/></entry>
- <entry><madmutt-doc:key>Return</madmutt-doc:key></entry>
- <entry>scroll down one line</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-entry"/></entry>
- <entry><madmutt-doc:key>J</madmutt-doc:key></entry>
- <entry>move to the next entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-new"/></entry>
- <entry></entry>
- <entry>jump to the next new message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-new-then-unread"/></entry>
- <entry><madmutt-doc:key>Tab</madmutt-doc:key></entry>
- <entry>jump to the next new or unread message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-page"/></entry>
- <entry></entry>
- <entry>move to the next page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">n</madmutt-doc:key></entry>
- <entry>jump to the next subthread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-thread"/></entry>
- <entry><madmutt-doc:key mod="C">N</madmutt-doc:key></entry>
- <entry>jump to the next thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-undeleted"/></entry>
- <entry><madmutt-doc:key>j</madmutt-doc:key></entry>
- <entry>move to the next undeleted message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="next-unread"/></entry>
- <entry></entry>
- <entry>jump to the next unread message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="parent-message"/></entry>
- <entry><madmutt-doc:key>P</madmutt-doc:key></entry>
- <entry>jump to parent message in thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="pipe-message"/></entry>
- <entry><madmutt-doc:key>|</madmutt-doc:key></entry>
- <entry>pipe message/attachment to a shell command</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-line"/></entry>
- <entry><madmutt-doc:key>BackSpace</madmutt-doc:key></entry>
- <entry>scroll up one line</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-entry"/></entry>
- <entry><madmutt-doc:key>K</madmutt-doc:key></entry>
- <entry>move to the previous entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-new"/></entry>
- <entry></entry>
- <entry>jump to the previous new message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-new-then-unread"/></entry>
- <entry></entry>
- <entry>jump to the previous new or unread message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-page"/></entry>
- <entry><madmutt-doc:key>-</madmutt-doc:key></entry>
- <entry>move to the previous page</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">p</madmutt-doc:key></entry>
- <entry>jump to previous subthread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-thread"/></entry>
- <entry><madmutt-doc:key mod="C">P</madmutt-doc:key></entry>
- <entry>jump to previous thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-undeleted"/></entry>
- <entry><madmutt-doc:key>k</madmutt-doc:key></entry>
- <entry>move to the last undelete message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="previous-unread"/></entry>
- <entry></entry>
- <entry>jump to the previous unread message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="print-message"/></entry>
- <entry><madmutt-doc:key>p</madmutt-doc:key></entry>
- <entry>print the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="quit"/></entry>
- <entry><madmutt-doc:key>Q</madmutt-doc:key></entry>
- <entry>save changes to mailbox and quit</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="read-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">r</madmutt-doc:key></entry>
- <entry>mark the current subthread as read</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="read-thread"/></entry>
- <entry><madmutt-doc:key mod="C">R</madmutt-doc:key></entry>
- <entry>mark the current thread as read</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="recall-message"/></entry>
- <entry><madmutt-doc:key>R</madmutt-doc:key></entry>
- <entry>recall a postponed message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="redraw-screen"/></entry>
- <entry><madmutt-doc:key mod="C">L</madmutt-doc:key></entry>
- <entry>clear and redraw the screen</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="reply"/></entry>
- <entry><madmutt-doc:key>r</madmutt-doc:key></entry>
- <entry>reply to a message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="save-message"/></entry>
- <entry><madmutt-doc:key>s</madmutt-doc:key></entry>
- <entry>save message/attachment to a file</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search"/></entry>
- <entry><madmutt-doc:key>/</madmutt-doc:key></entry>
- <entry>search for a regular expression</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-next"/></entry>
- <entry><madmutt-doc:key>n</madmutt-doc:key></entry>
- <entry>search for next match</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-opposite"/></entry>
- <entry></entry>
- <entry>search for next match in opposite direction</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-reverse"/></entry>
- <entry><madmutt-doc:key mod="E">/</madmutt-doc:key></entry>
- <entry>search backwards for a regular expression</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-toggle"/></entry>
- <entry><madmutt-doc:key>\</madmutt-doc:key></entry>
- <entry>toggle search pattern coloring</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="shell-escape"/></entry>
- <entry><madmutt-doc:key>!</madmutt-doc:key></entry>
- <entry>invoke a command in a subshell</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="show-version"/></entry>
- <entry><madmutt-doc:key>V</madmutt-doc:key></entry>
- <entry>show the Madmutt version number and date</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="skip-quoted"/></entry>
- <entry><madmutt-doc:key>S</madmutt-doc:key></entry>
- <entry>skip beyond quoted text</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="sync-mailbox"/></entry>
- <entry><madmutt-doc:key>$</madmutt-doc:key></entry>
- <entry>save changes to mailbox</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="tag-message"/></entry>
- <entry><madmutt-doc:key>t</madmutt-doc:key></entry>
- <entry>tag a message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="toggle-quoted"/></entry>
- <entry><madmutt-doc:key>T</madmutt-doc:key></entry>
- <entry>toggle display of quoted text</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="top"/></entry>
- <entry><madmutt-doc:key>^</madmutt-doc:key></entry>
- <entry>jump to the top of the message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-message"/></entry>
- <entry><madmutt-doc:key>u</madmutt-doc:key></entry>
- <entry>undelete the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-subthread"/></entry>
- <entry><madmutt-doc:key mod="E">u</madmutt-doc:key></entry>
- <entry>undelete all messages in subthread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-thread"/></entry>
- <entry><madmutt-doc:key mod="C">U</madmutt-doc:key></entry>
- <entry>undelete all messages in thread</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="view-attachments"/></entry>
- <entry><madmutt-doc:key>v</madmutt-doc:key></entry>
- <entry>show MIME attachments</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-alias">
- <title>alias</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Alias Menu Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="search"/></entry>
- <entry><madmutt-doc:key>/</madmutt-doc:key></entry>
- <entry>search for a regular expression</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-next"/></entry>
- <entry><madmutt-doc:key>n</madmutt-doc:key></entry>
- <entry>search for next match</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-reverse"/></entry>
- <entry><madmutt-doc:key mod="E">/</madmutt-doc:key></entry>
- <entry>search backwards for a regular expression</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-query">
- <title>query</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Query Menu Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="create-alias"/></entry>
- <entry><madmutt-doc:key>a</madmutt-doc:key></entry>
- <entry>create an alias from a message sender</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="mail"/></entry>
- <entry><madmutt-doc:key>m</madmutt-doc:key></entry>
- <entry>compose a new mail message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="query"/></entry>
- <entry><madmutt-doc:key>Q</madmutt-doc:key></entry>
- <entry>query external program for addresses</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="query-append"/></entry>
- <entry><madmutt-doc:key>A</madmutt-doc:key></entry>
- <entry>append new query results to current results</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search"/></entry>
- <entry><madmutt-doc:key>/</madmutt-doc:key></entry>
- <entry>search for a regular expression</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-next"/></entry>
- <entry><madmutt-doc:key>n</madmutt-doc:key></entry>
- <entry>search for next match</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-opposite"/></entry>
- <entry></entry>
- <entry>search for next match in opposite direction</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-reverse"/></entry>
- <entry><madmutt-doc:key mod="E">/</madmutt-doc:key></entry>
- <entry>search backwards for a regular expression</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-attach">
- <title>attach</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Attachment Menu Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="bounce-message"/></entry>
- <entry><madmutt-doc:key>b</madmutt-doc:key></entry>
- <entry>remail a message to another user</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="collapse-parts"/></entry>
- <entry><madmutt-doc:key>v</madmutt-doc:key></entry>
- <entry>toggle display of subparts</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-entry"/></entry>
- <entry><madmutt-doc:key>d</madmutt-doc:key></entry>
- <entry>delete the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="display-toggle-weed"/></entry>
- <entry><madmutt-doc:key>h</madmutt-doc:key></entry>
- <entry>display message and toggle header weeding</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-type"/></entry>
- <entry><madmutt-doc:key mod="C">E</madmutt-doc:key></entry>
- <entry>edit the current entry's Content-Type</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="extract-keys"/></entry>
- <entry><madmutt-doc:key mod="C">K</madmutt-doc:key></entry>
- <entry>extract PGP public keys</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="forward-message"/></entry>
- <entry><madmutt-doc:key>f</madmutt-doc:key></entry>
- <entry>forward a message with comments</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="group-reply"/></entry>
- <entry><madmutt-doc:key>g</madmutt-doc:key></entry>
- <entry>reply to all recipients</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="list-reply"/></entry>
- <entry><madmutt-doc:key>L</madmutt-doc:key></entry>
- <entry>reply to specified mailing list</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="pipe-entry"/></entry>
- <entry><madmutt-doc:key>|</madmutt-doc:key></entry>
- <entry>pipe message/attachment to a shell command</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="print-entry"/></entry>
- <entry><madmutt-doc:key>p</madmutt-doc:key></entry>
- <entry>print the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="reply"/></entry>
- <entry><madmutt-doc:key>r</madmutt-doc:key></entry>
- <entry>reply to a message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="resend-message"/></entry>
- <entry><madmutt-doc:key mod="E">e</madmutt-doc:key></entry>
- <entry>resend message and preserve MIME structure</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="save-entry"/></entry>
- <entry><madmutt-doc:key>s</madmutt-doc:key></entry>
- <entry>save message/attachment to a file</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-entry"/></entry>
- <entry><madmutt-doc:key>u</madmutt-doc:key></entry>
- <entry>undelete the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="view-attach"/></entry>
- <entry><madmutt-doc:key>Return</madmutt-doc:key></entry>
- <entry>view attachment using mailcap entry if necessary</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="view-mailcap"/></entry>
- <entry><madmutt-doc:key>m</madmutt-doc:key></entry>
- <entry>force viewing of attachment using mailcap</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="view-text"/></entry>
- <entry><madmutt-doc:key>T</madmutt-doc:key></entry>
- <entry>view attachment as text</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-compose">
- <title>compose</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Compose Menu Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="attach-file"/></entry>
- <entry><madmutt-doc:key>a</madmutt-doc:key></entry>
- <entry>attach a file(s) to this message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="attach-message"/></entry>
- <entry><madmutt-doc:key>A</madmutt-doc:key></entry>
- <entry>attach message(s) to this message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="attach-key"/></entry>
- <entry><madmutt-doc:key mod="E">k</madmutt-doc:key></entry>
- <entry>attach a PGP public key</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="copy-file"/></entry>
- <entry><madmutt-doc:key>C</madmutt-doc:key></entry>
- <entry>save message/attachment to a file</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="detach-file"/></entry>
- <entry><madmutt-doc:key>D</madmutt-doc:key></entry>
- <entry>delete the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="display-toggle-weed"/></entry>
- <entry><madmutt-doc:key>h</madmutt-doc:key></entry>
- <entry>display message and toggle header weeding</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-bcc"/></entry>
- <entry><madmutt-doc:key>b</madmutt-doc:key></entry>
- <entry>edit the BCC list</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-cc"/></entry>
- <entry><madmutt-doc:key>c</madmutt-doc:key></entry>
- <entry>edit the CC list</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-description"/></entry>
- <entry><madmutt-doc:key>d</madmutt-doc:key></entry>
- <entry>edit attachment description</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-encoding"/></entry>
- <entry><madmutt-doc:key mod="C">E</madmutt-doc:key></entry>
- <entry>edit attachment transfer-encoding</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-fcc"/></entry>
- <entry><madmutt-doc:key>f</madmutt-doc:key></entry>
- <entry>enter a file to save a copy of this message in</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-from"/></entry>
- <entry><madmutt-doc:key mod="E">f</madmutt-doc:key></entry>
- <entry>edit the from: field</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-file"/></entry>
- <entry><madmutt-doc:key mod="C">X e</madmutt-doc:key></entry>
- <entry>edit the file to be attached</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-headers"/></entry>
- <entry><madmutt-doc:key>E</madmutt-doc:key></entry>
- <entry>edit the message with headers</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit"/></entry>
- <entry><madmutt-doc:key>e</madmutt-doc:key></entry>
- <entry>edit the message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-mime"/></entry>
- <entry><madmutt-doc:key>m</madmutt-doc:key></entry>
- <entry>edit attachment using mailcap entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-reply-to"/></entry>
- <entry><madmutt-doc:key>r</madmutt-doc:key></entry>
- <entry>edit the Reply-To field</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-subject"/></entry>
- <entry><madmutt-doc:key>s</madmutt-doc:key></entry>
- <entry>edit the subject of this message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-to"/></entry>
- <entry><madmutt-doc:key>t</madmutt-doc:key></entry>
- <entry>edit the TO list</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="edit-type"/></entry>
- <entry><madmutt-doc:key mod="C">T</madmutt-doc:key></entry>
- <entry>edit attachment type</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="filter-entry"/></entry>
- <entry><madmutt-doc:key>F</madmutt-doc:key></entry>
- <entry>filter attachment through a shell command</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="forget-passphrase"/></entry>
- <entry><madmutt-doc:key mod="C">F</madmutt-doc:key></entry>
- <entry>wipe PGP passphrase from memory</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="ispell"/></entry>
- <entry><madmutt-doc:key>i</madmutt-doc:key></entry>
- <entry>run ispell on the message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="new-mime"/></entry>
- <entry><madmutt-doc:key>n</madmutt-doc:key></entry>
- <entry>compose new attachment using mailcap entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="pgp-menu"/></entry>
- <entry><madmutt-doc:key>p</madmutt-doc:key></entry>
- <entry>show PGP options</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="pipe-entry"/></entry>
- <entry><madmutt-doc:key>|</madmutt-doc:key></entry>
- <entry>pipe message/attachment to a shell command</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="postpone-message"/></entry>
- <entry><madmutt-doc:key>P</madmutt-doc:key></entry>
- <entry>save this message to send later</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="print-entry"/></entry>
- <entry><madmutt-doc:key>l</madmutt-doc:key></entry>
- <entry>print the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="rename-file"/></entry>
- <entry><madmutt-doc:key>R</madmutt-doc:key></entry>
- <entry>rename/move an attached file</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="send-message"/></entry>
- <entry><madmutt-doc:key>y</madmutt-doc:key></entry>
- <entry>send the message</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="toggle-unlink"/></entry>
- <entry><madmutt-doc:key>u</madmutt-doc:key></entry>
- <entry>toggle whether to delete file after sending it</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="view-attach"/></entry>
- <entry><madmutt-doc:key>Return</madmutt-doc:key></entry>
- <entry>view attachment using mailcap entry if necessary</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="write-fcc"/></entry>
- <entry><madmutt-doc:key>w</madmutt-doc:key></entry>
- <entry>write the message to a folder</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-postpone">
- <title>postpone</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Postpone Menu Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="delete-entry"/></entry>
- <entry><madmutt-doc:key>d</madmutt-doc:key></entry>
- <entry>delete the current entry</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="undelete-entry"/></entry>
- <entry><madmutt-doc:key>u</madmutt-doc:key></entry>
- <entry>undelete the current entry</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-browser">
- <title>browser</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Browser Menu Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="change-dir"/></entry>
- <entry><madmutt-doc:key>c</madmutt-doc:key></entry>
- <entry>change directories</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="check-new"/></entry>
- <entry><madmutt-doc:key>Tab</madmutt-doc:key></entry>
- <entry>check mailboxes for new mail</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="enter-mask"/></entry>
- <entry><madmutt-doc:key>m</madmutt-doc:key></entry>
- <entry>enter a file mask</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search"/></entry>
- <entry><madmutt-doc:key>/</madmutt-doc:key></entry>
- <entry>search for a regular expression</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-next"/></entry>
- <entry><madmutt-doc:key>n</madmutt-doc:key></entry>
- <entry>search for next match</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="search-reverse"/></entry>
- <entry><madmutt-doc:key mod="E">/</madmutt-doc:key></entry>
- <entry>search backwards for a regular expression</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="select-new"/></entry>
- <entry><madmutt-doc:key>N</madmutt-doc:key></entry>
- <entry>select a new file in this directory</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="sort"/></entry>
- <entry><madmutt-doc:key>o</madmutt-doc:key></entry>
- <entry>sort messages</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="sort-reverse"/></entry>
- <entry><madmutt-doc:key>O</madmutt-doc:key></entry>
- <entry>sort messages in reverse order</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="toggle-mailboxes"/></entry>
- <entry><madmutt-doc:key>Tab</madmutt-doc:key></entry>
- <entry>toggle whether to browse mailboxes or all files</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="view-file"/></entry>
- <entry><madmutt-doc:key>Space</madmutt-doc:key></entry>
- <entry>view file</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="subscribe"/></entry>
- <entry><madmutt-doc:key>s</madmutt-doc:key></entry>
- <entry>subscribe to current mailbox (IMAP Only)</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="unsubscribe"/></entry>
- <entry><madmutt-doc:key>u</madmutt-doc:key></entry>
- <entry>unsubscribe to current mailbox (IMAP Only)</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="toggle-subscribed"/></entry>
- <entry><madmutt-doc:key>T</madmutt-doc:key></entry>
- <entry>toggle view all/subscribed mailboxes (IMAP Only)</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-crypto">
- <title>pgp</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default PGP Menu Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="view-name"/></entry>
- <entry><madmutt-doc:key>%</madmutt-doc:key></entry>
- <entry>view the key's user id</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="verify-key"/></entry>
- <entry><madmutt-doc:key>c</madmutt-doc:key></entry>
- <entry>verify a PGP public key</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-editor">
- <title>editor</title>
-
- <para>
-
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Reference: Default Editor Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Function</entry>
- <entry>Default Key</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><madmutt-doc:funcref name="backspace"/></entry>
- <entry><madmutt-doc:key>BackSpace</madmutt-doc:key></entry>
- <entry>delete the char in front of the cursor</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="backward-char"/></entry>
- <entry><madmutt-doc:key mod="C">B</madmutt-doc:key></entry>
- <entry>move the cursor one character to the left</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="backward-word"/></entry>
- <entry><madmutt-doc:key mod="E">b</madmutt-doc:key></entry>
- <entry>move the cursor to the previous word</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="bol"/></entry>
- <entry><madmutt-doc:key mod="C">A</madmutt-doc:key></entry>
- <entry>jump to the beginning of the line</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="buffy-cycle"/></entry>
- <entry><madmutt-doc:key>Space</madmutt-doc:key></entry>
- <entry>cycle among incoming mailboxes</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="capitalize-word"/></entry>
- <entry><madmutt-doc:key mod="E">c</madmutt-doc:key></entry>
- <entry>uppercase the first character in the word</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="complete"/></entry>
- <entry><madmutt-doc:key>Tab</madmutt-doc:key></entry>
- <entry>complete filename or alias</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="complete-query"/></entry>
- <entry><madmutt-doc:key mod="C">T</madmutt-doc:key></entry>
- <entry>complete address with query</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="delete-char"/></entry>
- <entry><madmutt-doc:key mod="C">D</madmutt-doc:key></entry>
- <entry>delete the char under the cursor</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="downcase-word"/></entry>
- <entry><madmutt-doc:key mod="E">l</madmutt-doc:key></entry>
- <entry>lowercase all characters in current word</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="eol"/></entry>
- <entry><madmutt-doc:key mod="C">E</madmutt-doc:key></entry>
- <entry>jump to the end of the line</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="forward-char"/></entry>
- <entry><madmutt-doc:key mod="C">F</madmutt-doc:key></entry>
- <entry>move the cursor one character to the right</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="forward-word"/></entry>
- <entry><madmutt-doc:key mod="E">f</madmutt-doc:key></entry>
- <entry>move the cursor to the next word</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="history-down"/></entry>
- <entry></entry>
- <entry>scroll down through the history list</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="history-up"/></entry>
- <entry></entry>
- <entry>scroll up through the history list</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="kill-eol"/></entry>
- <entry><madmutt-doc:key mod="C">K</madmutt-doc:key></entry>
- <entry>delete chars from cursor to end of line</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="kill-eow"/></entry>
- <entry><madmutt-doc:key mod="E">d</madmutt-doc:key></entry>
- <entry>delete chars from cursor to end of word</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="kill-line"/></entry>
- <entry><madmutt-doc:key mod="C">U</madmutt-doc:key></entry>
- <entry>delete all chars on the line</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="kill-word"/></entry>
- <entry><madmutt-doc:key mod="C">W</madmutt-doc:key></entry>
- <entry>delete the word in front of the cursor</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="quote-char"/></entry>
- <entry><madmutt-doc:key mod="C">V</madmutt-doc:key></entry>
- <entry>quote the next typed key</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="transpose-chars"/></entry>
- <entry></entry>
- <entry>transpose character under cursor with previous</entry>
- </row>
- <row>
- <entry><madmutt-doc:funcref name="upcase-word"/></entry>
- <entry><madmutt-doc:key mod="E">u</madmutt-doc:key></entry>
- <entry>uppercase all characters in current word</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-
- </para>
-
- </sect2>
-
- <sect2 id="functions-sidebar">
- <title>sidebar</title>
-
- <para>
- <table frame="none" rowsep="1" texstr="l|l|l">
- <title>Referene: Default Sidebar Function Bindings</title>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Key</entry>
- <entry>Function</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry></entry>
- <entry><madmutt-doc:funcref name="sidebar-scroll-up"/></entry>
- <entry>Scrolls the mailbox list up 1 page</entry>
- </row>
- <row>
- <entry></entry>
- <entry><madmutt-doc:funcref name="sidebar-scroll-down"/></entry>
- <entry>Scrolls the mailbox list down 1 page</entry>
- </row>
- <row>
- <entry></entry>
- <entry><madmutt-doc:funcref name="sidebar-next"/></entry>
- <entry>Highlights the next mailbox</entry>
- </row>
- <row>
- <entry></entry>
- <entry><madmutt-doc:funcref name="sidebar-next-new"/></entry>
- <entry>Highlights the next mailbox with new mail</entry>
- </row>
- <row>
- <entry></entry>
- <entry><madmutt-doc:funcref name="sidebar-previous"/></entry>
- <entry>Highlights the previous mailbox</entry>
- </row>
- <row>
- <entry></entry>
- <entry><madmutt-doc:funcref name="sidebar-open"/></entry>
- <entry>Opens the currently highlighted mailbox</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
-
- </sect2>
-
- </sect1>
-
- </chapter>
-
- <appendix id="acknowledgments">
- <title>Acknowledgments</title>
-
- <para>
- Kari Hurtta <email>kari.hurtta@fmi.fi</email> co-developed the
- original MIME
- >parsing code back in the ELM-ME days.
- </para>
-
- <para> The following people have been very helpful to the development of
- Mutt (sorted by surnames):
- </para>
-
- <para>
- <itemizedlist>
- <listitem>
- Vikas Agnihotri <email>vikasa@writeme.com</email>
- </listitem>
- <listitem>
- Francois Berjon <email> Francois.Berjon@aar.alcatel-alsthom.fr</email>
- </listitem>
- <listitem>
- Aric Blumer <email>aric@fore.com</email>
- </listitem>
- <listitem>
- John Capo <email>jc@irbs.com</email>
- </listitem>
- <listitem>
- David Champion <email>dgc@uchicago.edu</email>
- </listitem>
- <listitem>
- Brendan Cully <email>brendan@kublai.com</email>
- </listitem>
- <listitem>
- Liviu Daia <email>daia@stoilow.imar.ro</email>
- </listitem>
- <listitem>
- Thomas E. Dickey <email>dickey@herndon4.his.com</email>
- </listitem>
- <listitem>
- David DeSimone <email>fox@convex.hp.com</email>
- </listitem>
- <listitem>
- Nickolay N. Dudorov <email>nnd@wint.itfs.nsk.su</email>
- </listitem>
- <listitem>
- Ruslan Ermilov <email>ru@freebsd.org</email>
- </listitem>
- <listitem>
- Edmund Grimley Evans <email>edmundo@rano.org</email>
- </listitem>
- <listitem>
- Michael Finken <email>finken@conware.de</email>
- </listitem>
- <listitem>
- Sven Guckes <email>guckes@math.fu-berlin.de</email>
- </listitem>
- <listitem>
- Lars Hecking <email>lhecking@nmrc.ie</email>
- </listitem>
- <listitem>
- Mark Holloman <email>holloman@nando.net</email>
- </listitem>
- <listitem>
- Andreas Holzmann <email>holzmann@fmi.uni-passau.de</email>
- </listitem>
- <listitem>
- Marco d'Itri <email>md@linux.it</email>
- </listitem>
- <listitem>
- Björn Jacke <email>bjacke@suse.com</email>
- </listitem>
- <listitem>
- Byrial Jensen <email>byrial@image.dk</email>
- </listitem>
- <listitem>
- David Jeske <email>jeske@igcom.net</email>
- </listitem>
- <listitem>
- Christophe Kalt <email>kalt@hugo.int-evry.fr</email>
- </listitem>
- <listitem>
- Tommi Komulainen <email>Tommi.Komulainen@iki.fi</email>
- </listitem>
- <listitem>
- Felix von Leitner (a.k.a ``Fefe'') <email>
- leitner@math.fu-berlin.de
- </email>
- </listitem>
- <listitem>
- Brandon Long <email>blong@fiction.net</email>
- </listitem>
- <listitem>
- Jimmy Mäkeä <email>jmy@flashback.net</email>
- </listitem>
- <listitem>
- Lars Marowsky-Bree <email>lmb@pointer.in-minden.de</email>
- </listitem>
- <listitem>
- Thomas ``Mike'' Michlmayr <email>mike@cosy.sbg.ac.at</email>
- </listitem>
- <listitem>
- Andrew W. Nosenko <email>awn@bcs.zp.ua</email>
- </listitem>
- <listitem>
- David O'Brien <email>obrien@Nuxi.cs.ucdavis.edu</email>
- </listitem>
- <listitem>
- Clint Olsen <email>olsenc@ichips.intel.com</email>
- </listitem>
- <listitem>
- Park Myeong Seok <email>pms@romance.kaist.ac.kr</email>
- </listitem>
- <listitem>
- Thomas Parmelan <email>tom@ankh.fr.eu.org</email>
- </listitem>
- <listitem>
- Ollivier Robert <email>roberto@keltia.freenix.fr</email>
- </listitem>
- <listitem>
- Thomas Roessler <email>roessler@does-not-exist.org</email>
- </listitem>
- <listitem>
- Roland Rosenfeld <email>roland@spinnaker.de</email>
- </listitem>
- <listitem>
- TAKIZAWA Takashi <email>taki@luna.email.ne.jp</email>
- </listitem>
- <listitem>
- Allain Thivillon <email>Allain.Thivillon@alma.fr</email>
- </listitem>
- <listitem>
- Gero Treuner <email>gero@70t.de</email>
- </listitem>
- <listitem>
- Vsevolod Volkov <email>vvv@lucky.net</email>
- </listitem>
- <listitem>
- Ken Weinert <email>kenw@ihs.com</email>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- Madmutt is developed by the following people:
- </para>
-
- <para>
- <itemizedlist>
- <listitem>
- Andreas Krennmair <email>ak@synflood.at</email>
- </listitem>
- <listitem>
- Nico Golde <email>nico@ngolde.de</email>
- </listitem>
- <listitem>
- Rocco Rutte <email>pdmef@cs.tu-berlin.de</email>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- The following people have been very helpful to the
- development of Madmutt (sorted by surnames):
- </para>
-
- <para>
- <itemizedlist>
- <listitem>
- Christian Gall <email>cg@cgall.de</email>
- </listitem>
- <listitem>
- Iain Lea <email>iain@bricbrac.de</email>
- </listitem>
- <listitem>
- Andreas Kneib <email>akneib@gmx.net</email>
- </listitem>
- <listitem>
- Felix Meinhold <email>felix.meinhold@gmx.net</email>
- </listitem>
- <listitem>
- Carsten Schoelzki <email>cjs@weisshuhn.de</email>
- </listitem>
- <listitem>
- Elimar Riesebieter <email>riesebie@lxtec.de</email>
- </listitem>
- </itemizedlist>
- </para>
-
- </appendix>
-
- <appendix id="hacking-documentation">
- <title>Hacking Documentation</title>
-
- <para>
- This manual is written in XML and transformed via a XSLT
- stylesheet into valid DocBook/XML and/or <madmutt-doc:special
- docbook="LaTeX" latex="\LaTeX{}"/> to be again transformed via a
- XSLT stylesheet into the final formats.
- </para>
-
- <para>
- This two pass processing is required to keep the file size low
- and to sanitize use, i.e. drastically lower the typing
- overhead.
- </para>
-
- <para>
- To achieve the latter, the sources come with a file called
- <literal>madmutt-manual.xsl</literal> introducing the
- <literal>madmutt-doc</literal> namespace which offers the following
- tags to be used (<emphasis>note: this is far from being
- complete, any help towards consistency is <emphasis
- role="bold">highly</emphasis> appreciated</emphasis>).
- </para>
-
- <para>
- <variablelist>
- <varlistentry>
- <term><literal><madmutt-doc:man name="" [sect=""]/></literal></term>
- <listitem><para>
- <emphasis>References to manual pages.</emphasis> If the
- <literal>sect</literal> parameter is omitted, it'll
- be 1 for the commands section. There's no auto-indexing yet.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:envvar name=""/></literal></term>
- <listitem><para>
- <emphasis>References to environment
- variables.</emphasis> The <literal>name</literal>
- parameter must contain upper-case letters only without
- the dollar sign as it'll be added automatically.
- Auto-indexing is done.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:hook name=""/></literal></term>
- <listitem><para>
- <emphasis>References to hooks.</emphasis> The string
- <literal>-hook</literal> will be added automatically to
- the value given in the <literal>name</literal>
- parameter. All entries will be auto-indexed.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:pattern name="" [full="1"]/></literal></term>
- <listitem><para>
- <emphasis>References to patterns.</emphasis> The
- <literal>name</literal> parameter must only contain the
- letter/symbol for the pattern as the tilde symbol/equal
- sign will be added automatically. Auto-indexing is done. If the
- <literal>full</literal> parameter is given the equal sign as well
- as tilde will be printed for a fully complete reference.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:key [mod="C|E"]>key</madmutt-doc:key></literal></term>
- <listitem><para>
- <emphasis>Referencing a key.</emphasis>. Because it's
- somewhat untrivial to always get the right escaping for
- <madmutt-doc:special docbook="LaTeX" latex="\LaTeX{}"/>,
- there's a tag for it. The optional modifiers
- <literal>C</literal> or <literal>E</literal> stand for
- Control and Escape respectively. To still allow
- escaping, the actual key sequences must be given within
- the tag.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:funcdef name=""/></literal></term>
- <listitem><para>
- <emphasis>Defining a command.</emphasis>. It's used to
- define a command with the name given in the
- <literal>name</literal> parameter. The default key
- binding must be given via
- <literal><madmutt-doc:key/></literal> (see above). The string
- will be automatically enclosed in
- <literal><></literal>. Auto-indexing is done.
- Also an anchor with id
- <literal>func-[name]</literal> will be added with
- <literal>[name]</literal> being the value of the
- <literal>name</literal> parameter.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:funcref name=""/></literal></term>
- <listitem><para>
- <emphasis>References to functions.</emphasis>. This is
- practically the same as the above except that there's no
- anchor defined.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:vardef name=""/></literal></term>
- <listitem><para>
- <emphasis>Defining a variable.</emphasis> This is to be
- used by <literal>makedoc</literal> only to define a
- command with a given name and XML-normalized link given
- via <literal>id</literal>. Auto-indexing is done. The
- <literal>name</literal> parameter's value will be
- prefixed with a dollar sign as for environment
- variables.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:varref name=""/></literal></term>
- <listitem><para>
- <emphasis>References to variables.</emphasis> This
- practically is the same as above except that the text
- inbetween won't be wrapped within a
- <literal><sect1></literal> tag. Auto-indexing is
- the same as for the above. This one is intended for
- manual use.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:web url""/></literal></term>
- <listitem><para>
- <emphasis>Pretty print a linked URL</emphasis>. As for
- E-Mail addresses where the text (mostly) equals the
- link's target, URLs must be enclosed in
- <literal><></literal> (also this reduced redudant
- URL typing).
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:rfc num=""/></literal></term>
- <listitem><para>
- <emphasis>References to RfC documents.</emphasis> Use
- this to produce links to RfC document with number given
- as the <literal>num</literal> parameter. A link to
- <madmutt-doc:web url="http://www.faqs.org/"/> will be
- made. Auto-indexing is done under
- <emphasis>RfC</emphasis>.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:cmddef name="" [noanchor="1"]/></literal></term>
- <listitem><para>
- <emphasis>Defining a configuration command.</emphasis>
- The name of the command is given as the
- <literal>name</literal> parameter. In case a single
- command has multiple possible calling sequences, specify
- <literal>noanchor="1"</literal> for subsequent use.
- Auto-indexing is done. Specify the arguments within the
- tag.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:cmdref name=""/></literal></term>
- <listitem><para>
- <emphasis>References to configuration commands.</emphasis>
- Use this to refer to commands as it builds the proper
- internal reference name. Auto-indexing is done.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:lstconf/></literal>,
- <literal><madmutt-doc:lstmail/></literal>,
- <literal><madmutt-doc:lstshell/></literal>
- </term>
- <listitem><para>
- <emphasis>Screen layout by context.</emphasis> These are
- used to specify environments for different types of
- screen output. For DocBook output, all of these simply
- map to <literal><screen/></literal>. But as a
- possible future migration to LaTeX may be ahead,
- different languages defined for the
- <literal>listings.sty</literal> packages may be used to
- have proper syntax highlighting for these so that there
- must be a context sensitive distinction.
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal><madmutt-doc:special [docbook=""] [latex=""]/></literal></term>
- <listitem><para>
- This is intended for specifying special strings for
- either DocBook/XML or <madmutt-doc:special
- docbook="LaTeX" latex="\LaTeX{}"/>.
- </para></listitem>
- </varlistentry>
-
- </variablelist>
- </para>
-
- <para>
- Additional notes follow.
- </para>
-
- <para>
- <itemizedlist>
- <listitem>
- <para>To not fully bloat the XSL stylesheet
- procuding the <madmutt-doc:special docbook="LaTeX"
- latex="\LaTeX{}"/> code, all tables <emphasis>must</emphasis>
- have an attribute called <literal>texstr</literal> which is
- directly passed to <literal>longtable</literal>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- </appendix>
-
- <index/>
-
- </book>
projects / apps / madmutt.git / blobdiff