X-Git-Url: http://git.madism.org/?p=apps%2Fmadmutt.git;a=blobdiff_plain;f=doc%2Fmanual.xml.tail;h=6f600f4ac62d7eca3fa2abc170a18e55acf24a50;hp=4f6c38e38c2f6c386733037e5df77f0dcdc23d93;hb=7d29626ce4e1fa932c6349c7253e6f774df069fc;hpb=da5e1ce19f42beab0534e0e5fe39024a2c02812b diff --git a/doc/manual.xml.tail b/doc/manual.xml.tail index 4f6c38e..6f600f4 100644 --- a/doc/manual.xml.tail +++ b/doc/manual.xml.tail @@ -28,7 +28,7 @@ - +
Reference: Default Generic Function Bindings @@ -40,158 +40,163 @@ - - L + + L move to the bottom of the page - - not bound + + move current entry to bottom of page - - not bound + + move current entry to middle of page - - not bound + + move current entry to top of page - - : - enter a muttngrc command + + : + enter a madmuttrc command - - q + + q exit this menu - - = + + = move to the first entry - - ] + + ] scroll down 1/2 page - - [ + + [ scroll up 1/2 page - - ? + + ? this screen - - number + + number jump to an index number - - * + + * move to the last entry - - M + + M move to the middle of the page - - j + + j move to the next entry - - > + + > scroll down one line - - z + + z move to the next page - - k + + k move to the previous entry - - < + + > scroll up one line - - Z + + Z move to the previous page - - ^L + + + cycle through all defined mailboxes to rebuild all header caches + + + + L clear and redraw the screen - - / + + / search for a regular expression - - n + + n search for next match - - not bound + + search for next match in opposite direction - - ESC / + + / search backwards for a regular expression - - RET + + Return select the current entry - - ! + + ! run a program in a subshell - - t + + t toggle the tag on the current entry - - ; + + ; apply next command to tagged entries - - not bound + + apply next function ONLY to tagged messages - - H + + H move to the top of the page - - not bound + + display the keycode for a key press @@ -208,7 +213,7 @@ -
+
Reference: Default Index Function Bindings @@ -220,348 +225,348 @@ - - b + + b remail a message to another user - - c + + c open a different folder - - ESC c + + c open a different folder in read only mode - - ESC P + + P check for classic pgp - - W + + W clear a status flag from a message - - C + + C copy a message to a file/mailbox - - a + + a create an alias from a message sender - - ESC C + + C decode a message and copy it to a file/mailbox - - ESC s + + s decode a message and save it to a file/mailbox - - d + + d delete the current entry - - D + + D delete messages matching a pattern - - ESC d + + d delete all messages in subthread - - ^D + + D delete all messages in thread - - @ + + @ display full address of sender - - h + + h display message and toggle header weeding - - RET + + Return display a message - - e + + e edit the current message - - ^E + + E edit the current message's Content-Type - - x + + x exit without saving changes - - ^K + + K extract PGP public keys - - G + + G retrieve mail from POP server - - F + + F toggle a message's 'important' flag - - ^F + + F wipe PGP passphrase from memory - - f + + f forward a message with comments - - g + + g reply to all recipients - - l + + l show only messages matching a pattern - - L + + L reply to specified mailing list - - m + + m compose a new mail message - - ESC k + + k mail a PGP public key - - not bound + + jump to the next new message - - TAB + + Tab jump to the next new or unread message - - ESC n + + n jump to the next subthread - - ^N + + N jump to the next thread - - j + + j move to the next undeleted message - - not bound + + jump to the next unread message - - P + + P jump to parent message in thread - - | + + | pipe message/attachment to a shell command - - not bound + + jump to the previous new message - - ESC TAB + + Tab jump to the previous new or unread message - - Z + + Z move to the previous page - - ESC p + + p jump to previous subthread - - ^P + + P jump to previous thread - - k + + k move to the last undelete message - - not bound + + jump to the previous unread message - - p + + p print the current entry - - Q + + Q query external program for addresses - - q + + q save changes to mailbox and quit - - ESC r + + r mark the current subthread as read - - ^R + + R mark the current thread as read - - R + + R recall a postponed message - - r + + r reply to a message - - ESC e + + e resend message and preserve MIME structure - - s + + s save message/attachment to a file - - w + + w set a status flag on a message - - V - show the Mutt-ng version number and date + + V + show the Madmutt version number and date - - ESC l + + l show currently active limit pattern, if any - - o + + o sort messages - - O + + O sort messages in reverse order - - $ + + $ save changes to mailbox - - T + + T tag messages matching a pattern - - ESC t + + t tag/untag all messages in the current thread - - N + + N toggle a message's 'new' flag - - % + + % toggle whether the mailbox will be rewritten - - u + + u undelete the current entry - - U + + U undelete messages matching a pattern - - ESC u + + u undelete all messages in subthread - - ^U + + U undelete all messages in thread - - ^T + + T untag messages matching a pattern - - v + + v show MIME attachments @@ -578,7 +583,7 @@ -
+
Reference: Default Pager Function Bindings @@ -590,373 +595,373 @@ - - not bound + + jump to the bottom of the message - - b + + b remail a message to another user - - c + + c open a different folder - - ESC c + + c open a different folder in read only mode - - ESC P + + P check for classic pgp - - C + + C copy a message to a file/mailbox - - a + + a create an alias from a message - - ESC C + + C decode a message and copy it to a file/mailbox - - ESC s + + s decode a message and save it to a file/mailbox - - d + + d delete the current entry - - ESC d + + d delete all messages in subthread - - ^D + + D delete all messages in thread - - @ + + @ display full address of sender - - h + + h display message and toggle header weeding - - e + + e edit the current message - - ^E + + E edit the current message's Content-Type - - : - enter a muttngrc command + + : + enter a madmuttrc command - - i + + i return to the main-menu - - ^K + + K extract PGP public keys - - F + + F toggle a message's 'important' flag - - ^F + + F wipe PGP passphrase from memory - - f + + f forward a message with comments - - g + + g reply to all recipients - - not bound + + move up one-half page - - not bound + + move down one-half page - - ? + + ? this screen - - L + + L reply to specified mailing list - - m + + m compose a new mail message - - ESC k + + k mail a PGP public key - - N + + N toggle a message's 'new' flag - - RET + + Return scroll down one line - - J + + J move to the next entry - - not bound + + jump to the next new message - - TAB + + Tab jump to the next new or unread message - - not bound + + move to the next page - - ESC n + + n jump to the next subthread - - ^N + + N jump to the next thread - - j + + j move to the next undeleted message - - not bound + + jump to the next unread message - - P + + P jump to parent message in thread - - | + + | pipe message/attachment to a shell command - - BackSpace + + BackSpace scroll up one line - - K + + K move to the previous entry - - not bound + + jump to the previous new message - - not bound + + jump to the previous new or unread message - - - + + - move to the previous page - - ESC p + + p jump to previous subthread - - ^P + + P jump to previous thread - - k + + k move to the last undelete message - - not bound + + jump to the previous unread message - - p + + p print the current entry - - Q + + Q save changes to mailbox and quit - - ESC r + + r mark the current subthread as read - - ^R + + R mark the current thread as read - - R + + R recall a postponed message - - ^L + + L clear and redraw the screen - - r + + r reply to a message - - s + + s save message/attachment to a file - - / + + / search for a regular expression - - n + + n search for next match - - not bound + + search for next match in opposite direction - - ESC / + + / search backwards for a regular expression - - \ + + \ toggle search pattern coloring - - ! + + ! invoke a command in a subshell - - V - show the Mutt-ng version number and date + + V + show the Madmutt version number and date - - S + + S skip beyond quoted text - - $ + + $ save changes to mailbox - - t + + t tag a message - - T + + T toggle display of quoted text - - ^ + + ^ jump to the top of the message - - u + + u undelete the current entry - - ESC u + + u undelete all messages in subthread - - ^U + + U undelete all messages in thread - - v + + v show MIME attachments @@ -973,7 +978,7 @@ -
+
Reference: Default Alias Menu Function Bindings @@ -985,18 +990,18 @@ - - / + + / search for a regular expression - - n + + n search for next match - - ESC / + + / search backwards for a regular expression @@ -1013,7 +1018,7 @@ -
+
Reference: Default Query Menu Function Bindings @@ -1025,43 +1030,43 @@ - - a + + a create an alias from a message sender - - m + + m compose a new mail message - - Q + + Q query external program for addresses - - A + + A append new query results to current results - - / + + / search for a regular expression - - n + + n search for next match - - not bound + + search for next match in opposite direction - - ESC / + + / search backwards for a regular expression @@ -1078,7 +1083,7 @@ -
+
Reference: Default Attachment Menu Function Bindings @@ -1090,93 +1095,93 @@ - - b + + b remail a message to another user - - v + + v toggle display of subparts - - d + + d delete the current entry - - h + + h display message and toggle header weeding - - ^E + + E edit the current entry's Content-Type - - ^K + + K extract PGP public keys - - f + + f forward a message with comments - - g + + g reply to all recipients - - L + + L reply to specified mailing list - - | + + | pipe message/attachment to a shell command - - p + + p print the current entry - - r + + r reply to a message - - ESC e + + e resend message and preserve MIME structure - - s + + s save message/attachment to a file - - u + + u undelete the current entry - - RET + + Return view attachment using mailcap entry if necessary - - m + + m force viewing of attachment using mailcap - - T + + T view attachment as text @@ -1193,7 +1198,7 @@ -
+
Reference: Default Compose Menu Function Bindings @@ -1205,168 +1210,168 @@ - - a + + a attach a file(s) to this message - - A + + A attach message(s) to this message - - ESC k + + k attach a PGP public key - - C + + C save message/attachment to a file - - D + + D delete the current entry - - h + + h display message and toggle header weeding - - b + + b edit the BCC list - - c + + c edit the CC list - - d + + d edit attachment description - - ^E + + E edit attachment transfer-encoding - - f + + f enter a file to save a copy of this message in - - ESC f + + f edit the from: field - - ^X e + + X e edit the file to be attached - - E + + E edit the message with headers - - e + + e edit the message - - m + + m edit attachment using mailcap entry - - r + + r edit the Reply-To field - - s + + s edit the subject of this message - - t + + t edit the TO list - - ^T + + T edit attachment type - - F + + F filter attachment through a shell command - - ^F + + F wipe PGP passphrase from memory - - i + + i run ispell on the message - - n + + n compose new attachment using mailcap entry - - p + + p show PGP options - - | + + | pipe message/attachment to a shell command - - P + + P save this message to send later - - l + + l print the current entry - - R + + R rename/move an attached file - - y + + y send the message - - u + + u toggle whether to delete file after sending it - - RET + + Return view attachment using mailcap entry if necessary - - w + + w write the message to a folder @@ -1383,7 +1388,7 @@ -
+
Reference: Default Postpone Menu Function Bindings @@ -1395,13 +1400,13 @@ - - d + + d delete the current entry - - u + + u undelete the current entry @@ -1418,7 +1423,7 @@ -
+
Reference: Default Browser Menu Function Bindings @@ -1430,73 +1435,73 @@ - - c + + c change directories - - TAB + + Tab check mailboxes for new mail - - m + + m enter a file mask - - / + + / search for a regular expression - - n + + n search for next match - - ESC / + + / search backwards for a regular expression - - N + + N select a new file in this directory - - o + + o sort messages - - O + + O sort messages in reverse order - - TAB + + Tab toggle whether to browse mailboxes or all files - - SPACE + + Space view file - - s + + s subscribe to current mailbox (IMAP Only) - - u + + u unsubscribe to current mailbox (IMAP Only) - - T + + T toggle view all/subscribed mailboxes (IMAP Only) @@ -1513,7 +1518,7 @@ -
+
Reference: Default PGP Menu Function Bindings @@ -1525,13 +1530,13 @@ - - % + + % view the key's user id - - c + + c verify a PGP public key @@ -1548,7 +1553,7 @@ -
+
Reference: Default Editor Function Bindings @@ -1560,113 +1565,113 @@ - - BackSpace + + BackSpace delete the char in front of the cursor - - ^B + + B move the cursor one character to the left - - ESC b + + b move the cursor to the previous word - - ^A + + A jump to the beginning of the line - - Space + + Space cycle among incoming mailboxes - - ESC c + + c uppercase the first character in the word - - TAB + + Tab complete filename or alias - - ^T + + T complete address with query - - ^D + + D delete the char under the cursor - - ESC l + + l lowercase all characters in current word - - ^E + + E jump to the end of the line - - ^F + + F move the cursor one character to the right - - ESC f + + f move the cursor to the next word - - not bound + + scroll down through the history list - - not bound + + scroll up through the history list - - ^K + + K delete chars from cursor to end of line - - ESC d + + d delete chars from cursor to end of word - - ^U + + U delete all chars on the line - - ^W + + W delete the word in front of the cursor - - ^V + + V quote the next typed key - - not bound + + transpose character under cursor with previous - - ESC u + + u uppercase all characters in current word @@ -1682,7 +1687,7 @@ sidebar -
+
Referene: Default Sidebar Function Bindings @@ -1694,33 +1699,33 @@ - none - + + Scrolls the mailbox list up 1 page - none - + + Scrolls the mailbox list down 1 page - none - + + Highlights the next mailbox - none - + + Highlights the next mailbox with new mail - none - + + Highlights the previous mailbox - none - + + Opens the currently highlighted mailbox @@ -1756,9 +1761,10 @@ Francois Berjon Francois.Berjon@aar.alcatel-alsthom.fr - Aric Blumer aric@fore.com, John Capo - jc@irbs.com - + Aric Blumer aric@fore.com + + + John Capo jc@irbs.com David Champion dgc@uchicago.edu @@ -1865,7 +1871,7 @@ Allain Thivillon Allain.Thivillon@alma.fr - Gero Treuner gero@faveve.uni-stuttgart.de + Gero Treuner gero@70t.de Vsevolod Volkov vvv@lucky.net @@ -1877,7 +1883,7 @@ - Mutt-ng is developed by the following people: + Madmutt is developed by the following people: @@ -1896,7 +1902,7 @@ The following people have been very helpful to the - development of Mutt-ng (sorted by surnames): + development of Madmutt (sorted by surnames): @@ -1929,7 +1935,8 @@ This manual is written in XML and transformed via a XSLT - stylesheet into valid DocBook/XML to be again transformed via a + stylesheet into valid DocBook/XML and/or to be again transformed via a XSLT stylesheet into the final formats. @@ -1941,8 +1948,8 @@ To achieve the latter, the sources come with a file called - muttng-manual.xsl introducing the - muttng-doc namespace which offers the following + madmutt-manual.xsl introducing the + madmutt-doc namespace which offers the following tags to be used (note: this is far from being complete, any help towards consistency is highly appreciated). @@ -1951,7 +1958,7 @@ - <muttng-doc:man name="" [sect=""]/> + <madmutt-doc:man name="" [sect=""]/> References to manual pages. If the sect parameter is omitted, it'll @@ -1959,65 +1966,66 @@ - <muttng-doc:envvar name=""/> + <madmutt-doc:envvar name=""/> References to environment variables. The name parameter must contain upper-case letters only without the dollar sign as it'll be added automatically. - Auto-indexing under Environment - Variables is done. + Auto-indexing is done. - <muttng-doc:hook name=""/> + <madmutt-doc:hook name=""/> References to hooks. The string -hook will be added automatically to the value given in the name - parameter. All entries will be auto-indexed under - Hooks. + parameter. All entries will be auto-indexed. - <muttng-doc:command name=""/> - - References to configuration - commands. The name is given via the - name parameter and will be - auto-indexed under Configuration - Commands. - - - - <muttng-doc:pattern name="" [full="1"]/> + <madmutt-doc:pattern name="" [full="1"]/> References to patterns. The name parameter must only contain the letter/symbol for the pattern as the tilde symbol/equal - sign will be added automatically. Auto-indexing is done - under Patterns. If the - full is given the equal sign as well + sign will be added automatically. Auto-indexing is done. If the + full parameter is given the equal sign as well as tilde will be printed for a fully complete reference. - <muttng-doc:funcdef name="" key=""/> + <madmutt-doc:key [mod="C|E"]>key</madmutt-doc:key> + + Referencing a key.. Because it's + somewhat untrivial to always get the right escaping for + , + there's a tag for it. The optional modifiers + C or E stand for + Control and Escape respectively. To still allow + escaping, the actual key sequences must be given within + the tag. + + + + <madmutt-doc:funcdef name=""/> Defining a command.. It's used to define a command with the name given in the - name parameter and a default key - binding given via key. The string + name parameter. The default key + binding must be given via + <madmutt-doc:key/> (see above). The string will be automatically enclosed in - <>. Auto-indexing is done under - Functions. Also an anchor with id + <>. Auto-indexing is done. + Also an anchor with id func-[name] will be added with [name] being the value of the name parameter. - <muttng-doc:funcref name=""/> + <madmutt-doc:funcref name=""/> References to functions.. This is practically the same as the above except that there's no @@ -2025,20 +2033,19 @@ - <muttng-doc:vardef name="" id=""/> + <madmutt-doc:vardef name=""/> Defining a variable. This is to be used by makedoc only to define a command with a given name and XML-normalized link given - via id. Auto-indexing is done under - Configuration Variables. The + via id. Auto-indexing is done. The name parameter's value will be prefixed with a dollar sign as for environment variables. - <muttng-doc:varref name=""/> + <madmutt-doc:varref name=""/> References to variables. This practically is the same as above except that the text @@ -2049,7 +2056,7 @@ - <muttng-doc:web url""/> + <madmutt-doc:web url""/> Pretty print a linked URL. As for E-Mail addresses where the text (mostly) equals the @@ -2059,18 +2066,82 @@ - <muttng-doc:rfc num=""/> + <madmutt-doc:rfc num=""/> References to RfC documents. Use this to produce links to RfC document with number given as the num parameter. A link to - will be - made. Auto-indexing is not done yet. + will be + made. Auto-indexing is done under + RfC. + + + + <madmutt-doc:cmddef name="" [noanchor="1"]/> + + Defining a configuration command. + The name of the command is given as the + name parameter. In case a single + command has multiple possible calling sequences, specify + noanchor="1" for subsequent use. + Auto-indexing is done. Specify the arguments within the + tag. + + + + <madmutt-doc:cmdref name=""/> + + References to configuration commands. + Use this to refer to commands as it builds the proper + internal reference name. Auto-indexing is done. + + + + <madmutt-doc:lstconf/>, + <madmutt-doc:lstmail/>, + <madmutt-doc:lstshell/> + + + Screen layout by context. These are + used to specify environments for different types of + screen output. For DocBook output, all of these simply + map to <screen/>. But as a + possible future migration to LaTeX may be ahead, + different languages defined for the + listings.sty packages may be used to + have proper syntax highlighting for these so that there + must be a context sensitive distinction. + + <madmutt-doc:special [docbook=""] [latex=""]/> + + This is intended for specifying special strings for + either DocBook/XML or . + + + + + Additional notes follow. + + + + + + To not fully bloat the XSL stylesheet + procuding the code, all tables must + have an attribute called texstr which is + directly passed to longtable. + + + + +