X-Git-Url: http://git.madism.org/?p=apps%2Fmadmutt.git;a=blobdiff_plain;f=doc%2Fmanual.xml.tail;h=6f600f4ac62d7eca3fa2abc170a18e55acf24a50;hp=ebc29dad5bfd5b39a038e1d94295c40e84cfbd03;hb=a6f91e78d27906d413c9e53dc2ece06778e80412;hpb=4b2f985c0f88249774e03e9e4111b70f3d8d26dc diff --git a/doc/manual.xml.tail b/doc/manual.xml.tail index ebc29da..6f600f4 100644 --- a/doc/manual.xml.tail +++ b/doc/manual.xml.tail @@ -28,42 +28,181 @@ - - bottom-page L move to the bottom of the page - current-bottom not bound move current entry to bottom of page - current-middle not bound move current entry to middle of page - current-top not bound move current entry to top of page - enter-command : enter a muttngrc command - exit q exit this menu - first-entry = move to the first entry - half-down ] scroll down 1/2 page - half-up [ scroll up 1/2 page - help ? this screen - jump number jump to an index number - last-entry * move to the last entry - middle-page M move to the middle of the page - next-entry j move to the next entry - next-line > scroll down one line - next-page z move to the next page - previous-entry k move to the previous entry - previous-line < scroll up one line - previous-page Z move to the previous page - refresh ^L clear and redraw the screen - search / search for a regular expression - search-next n search for next match - search-opposite not bound search for next match in opposite - direction - search-reverse ESC / search backwards for a regular - expression - select-entry RET select the current entry - shell-escape ! run a program in a subshell - tag-entry t toggle the tag on the current entry - tag-prefix ; apply next command to tagged entries - tag-prefix-cond not bound apply next function ONLY to tagged - messages - top-page H move to the top of the page - what-key not bound display the keycode for a key press - + + Reference: Default Generic Function Bindings + + + + Function + Default Key + Description + + + + + + L + move to the bottom of the page + + + + + move current entry to bottom of page + + + + + move current entry to middle of page + + + + + move current entry to top of page + + + + : + enter a madmuttrc command + + + + q + exit this menu + + + + = + move to the first entry + + + + ] + scroll down 1/2 page + + + + [ + scroll up 1/2 page + + + + ? + this screen + + + + number + jump to an index number + + + + * + move to the last entry + + + + M + move to the middle of the page + + + + j + move to the next entry + + + + > + scroll down one line + + + + z + move to the next page + + + + k + move to the previous entry + + + + > + scroll up one line + + + + Z + move to the previous page + + + + + cycle through all defined mailboxes to rebuild all header caches + + + + L + clear and redraw the screen + + + + / + search for a regular expression + + + + n + search for next match + + + + + search for next match in opposite direction + + + + / + search backwards for a regular expression + + + + Return + select the current entry + + + + ! + run a program in a subshell + + + + t + toggle the tag on the current entry + + + + ; + apply next command to tagged entries + + + + + apply next function ONLY to tagged messages + + + + H + move to the top of the page + + + + + display the keycode for a key press + + + +
+
@@ -74,91 +213,366 @@ - - bounce-message b remail a message to another user - change-folder c open a different folder - change-folder-readonly ESC c open a different folder in read only - mode - check-traditional-pgp ESC P check for classic pgp - clear-flag W clear a status flag from a message - copy-message C copy a message to a file/mailbox - create-alias a create an alias from a message - senderdecode-copy ESC C decode a message and copy it - to a file/mailbox - decode-save ESC s decode a message and save it to a - file/mailbox - delete-message d delete the current entry - delete-pattern D delete messages matching a pattern - delete-subthread ESC d delete all messages in subthread - delete-thread ^D delete all messages in thread - display-address @ display full address of sender - display-toggle-weed h display message and toggle header - weeding - display-message RET display a message - edit e edit the current message - edit-type ^E edit the current message's - Content-Type - exit x exit without saving changes - extract-keys ^K extract PGP public keys - fetch-mail G retrieve mail from POP server - flag-message F toggle a message's 'important' flag - forget-passphrase ^F wipe PGP passphrase from memory - forward-message f forward a message with comments - group-reply g reply to all recipients - limit l show only messages matching a - patternlist-reply L reply to specified mailing - list - mail m compose a new mail message - mail-key ESC k mail a PGP public key - next-new not bound jump to the next new message - next-new-then-unread TAB jump to the next new or unread message - next-subthread ESC n jump to the next subthread - next-thread ^N jump to the next thread - next-undeleted j move to the next undeleted message - next-unread not bound jump to the next unread message - parent-message P jump to parent message in thread - pipe-message | pipe message/attachment to a shell - command - previous-new not bound jump to the previous new message - previous-new-then-unread - ESC TAB jump to the previous new or unread message + + Reference: Default Index Function Bindings + + + + Function + Default Key + Description + + + + + + b + remail a message to another user + + + + c + open a different folder + + + + c + open a different folder in read only mode + + + + P + check for classic pgp + + + + W + clear a status flag from a message + + + + C + copy a message to a file/mailbox + + + + a + create an alias from a message sender + + + + C + decode a message and copy it to a file/mailbox + + + + s + decode a message and save it to a file/mailbox + + + + d + delete the current entry + + + + D + delete messages matching a pattern + + + + d + delete all messages in subthread + + + + D + delete all messages in thread + + + + @ + display full address of sender + + + + h + display message and toggle header weeding + + + + Return + display a message + + + + e + edit the current message + + + + E + edit the current message's Content-Type + + + + x + exit without saving changes + + + + K + extract PGP public keys + + + + G + retrieve mail from POP server + + + + F + toggle a message's 'important' flag + + + + F + wipe PGP passphrase from memory + + + + f + forward a message with comments + + + + g + reply to all recipients + + + + l + show only messages matching a pattern + + + + L + reply to specified mailing list + + + + m + compose a new mail message + + + + k + mail a PGP public key + + + + + jump to the next new message + + + + Tab + jump to the next new or unread message + + + + n + jump to the next subthread + + + + N + jump to the next thread + + + + j + move to the next undeleted message + + + + + jump to the next unread message + + + + P + jump to parent message in thread + + + + | + pipe message/attachment to a shell command + + + + + jump to the previous new message + + + + Tab + jump to the previous new or unread message + + + + Z + move to the previous page + + + + p + jump to previous subthread + + + + P + jump to previous thread + + + + k + move to the last undelete message + + + + + jump to the previous unread message + + + + p + print the current entry + + + + Q + query external program for addresses + + + + q + save changes to mailbox and quit + + + + r + mark the current subthread as read + + + + R + mark the current thread as read + + + + R + recall a postponed message + + + + r + reply to a message + + + + e + resend message and preserve MIME structure + + + + s + save message/attachment to a file + + + + w + set a status flag on a message + + + + V + show the Madmutt version number and date + + + + l + show currently active limit pattern, if any + + + + o + sort messages + + + + O + sort messages in reverse order + + + + $ + save changes to mailbox + + + + T + tag messages matching a pattern + + + + t + tag/untag all messages in the current thread + + + + N + toggle a message's 'new' flag + + + + % + toggle whether the mailbox will be rewritten + + + + u + undelete the current entry + + + + U + undelete messages matching a pattern + + + + u + undelete all messages in subthread + + + + U + undelete all messages in thread + + + + T + untag messages matching a pattern + + + + v + show MIME attachments + + + +
- previous-page Z move to the previous page - previous-subthread ESC p jump to previous subthread - previous-thread ^P jump to previous thread - previous-undeleted k move to the last undelete message - previous-unread not bound jump to the previous unread message - print-message p print the current entry - query Q query external program for addresses - quit q save changes to mailbox and quit - read-subthread ESC r mark the current subthread as read - read-thread ^R mark the current thread as read - recall-message R recall a postponed message - reply r reply to a message - resend-message ESC e resend message and preserve MIME - structure - save-message s save message/attachment to a file - set-flag w set a status flag on a message - show-version V show the Mutt-ng version number and - date - show-limit ESC l show currently active limit pattern, - if any - sort-mailbox o sort messages - sort-reverse O sort messages in reverse order - sync-mailbox $ save changes to mailbox - tag-pattern T tag messages matching a pattern - tag-thread ESC t tag/untag all messages in the - current thread - toggle-new N toggle a message's 'new' flag - toggle-write % toggle whether the mailbox will be - rewritten - undelete-message u undelete the current entry - undelete-pattern U undelete messages matching a pattern - undelete-subthread ESC u undelete all messages in subthread - undelete-thread ^U undelete all messages in thread - untag-pattern ^T untag messages matching a pattern - view-attachments v show MIME attachments -
@@ -169,92 +583,391 @@ - - bottom not bound jump to the bottom of the message - bounce-message b remail a message to another user - change-folder c open a different folder - change-folder-readonly ESC c open a different folder in read only - mode - check-traditional-pgp ESC P check for classic pgp - copy-message C copy a message to a file/mailbox - create-alias a create an alias from a message - senderdecode-copy ESC C decode a message and copy it - to a file/mailbox - decode-save ESC s decode a message and save it to a - file/mailbox - delete-message d delete the current entry - delete-subthread ESC d delete all messages in subthread - delete-thread ^D delete all messages in thread - display-address @ display full address of sender - display-toggle-weed h display message and toggle header - weeding - edit e edit the current message - edit-type ^E edit the current message's - Content-Type - enter-command : enter a muttngrc command - exit i return to the main-menu - extract-keys ^K extract PGP public keys - flag-message F toggle a message's 'important' flag - forget-passphrase ^F wipe PGP passphrase from memory - forward-message f forward a message with comments - group-reply g reply to all recipients - half-up not bound move up one-half page - half-down not bound move down one-half page - help ? this screen - list-reply L reply to specified mailing list - mail m compose a new mail message - mail-key ESC k mail a PGP public key - mark-as-new N toggle a message's 'new' flag - next-line RET scroll down one line - next-entry J move to the next entry - next-new not bound jump to the next new message - next-new-then-unread TAB jump to the next new or unread message - next-page move to the next page - next-subthread ESC n jump to the next subthread - next-thread ^N jump to the next thread - next-undeleted j move to the next undeleted message - next-unread not bound jump to the next unread message - parent-message P jump to parent message in thread - pipe-message | pipe message/attachment to a shell - command - previous-line BackSpace scroll up one line - previous-entry K move to the previous entry - previous-new not bound jump to the previous new message - previous-new-then-unread - not bound jump to the previous new or unread message - previous-page - move to the previous page - previous-subthread ESC p jump to previous subthread - previous-thread ^P jump to previous thread - previous-undeleted k move to the last undelete message - previous-unread not bound jump to the previous unread message - print-message p print the current entry - quit Q save changes to mailbox and quit - read-subthread ESC r mark the current subthread as read - read-thread ^R mark the current thread as read - recall-message R recall a postponed message - redraw-screen ^L clear and redraw the screen - reply r reply to a message - save-message s save message/attachment to a file - search / search for a regular expression - search-next n search for next match - search-opposite not bound search for next match in opposite - direction - search-reverse ESC / search backwards for a regular - expression - search-toggle \ toggle search pattern coloring - shell-escape ! invoke a command in a subshell - show-version V show the Mutt-ng version number and - date - skip-quoted S skip beyond quoted text - sync-mailbox $ save changes to mailbox - tag-message t tag a message - toggle-quoted T toggle display of quoted text - top ^ jump to the top of the message - undelete-message u undelete the current entry - undelete-subthread ESC u undelete all messages in subthread - undelete-thread ^U undelete all messages in thread - view-attachments v show MIME attachments - + + Reference: Default Pager Function Bindings + + + + Function + Default Key + Description + + + + + + + jump to the bottom of the message + + + + b + remail a message to another user + + + + c + open a different folder + + + + c + open a different folder in read only mode + + + + P + check for classic pgp + + + + C + copy a message to a file/mailbox + + + + a + create an alias from a message + + + + C + decode a message and copy it to a file/mailbox + + + + s + decode a message and save it to a file/mailbox + + + + d + delete the current entry + + + + d + delete all messages in subthread + + + + D + delete all messages in thread + + + + @ + display full address of sender + + + + h + display message and toggle header weeding + + + + e + edit the current message + + + + E + edit the current message's Content-Type + + + + : + enter a madmuttrc command + + + + i + return to the main-menu + + + + K + extract PGP public keys + + + + F + toggle a message's 'important' flag + + + + F + wipe PGP passphrase from memory + + + + f + forward a message with comments + + + + g + reply to all recipients + + + + + move up one-half page + + + + + move down one-half page + + + + ? + this screen + + + + L + reply to specified mailing list + + + + m + compose a new mail message + + + + k + mail a PGP public key + + + + N + toggle a message's 'new' flag + + + + Return + scroll down one line + + + + J + move to the next entry + + + + + jump to the next new message + + + + Tab + jump to the next new or unread message + + + + + move to the next page + + + + n + jump to the next subthread + + + + N + jump to the next thread + + + + j + move to the next undeleted message + + + + + jump to the next unread message + + + + P + jump to parent message in thread + + + + | + pipe message/attachment to a shell command + + + + BackSpace + scroll up one line + + + + K + move to the previous entry + + + + + jump to the previous new message + + + + + jump to the previous new or unread message + + + + - + move to the previous page + + + + p + jump to previous subthread + + + + P + jump to previous thread + + + + k + move to the last undelete message + + + + + jump to the previous unread message + + + + p + print the current entry + + + + Q + save changes to mailbox and quit + + + + r + mark the current subthread as read + + + + R + mark the current thread as read + + + + R + recall a postponed message + + + + L + clear and redraw the screen + + + + r + reply to a message + + + + s + save message/attachment to a file + + + + / + search for a regular expression + + + + n + search for next match + + + + + search for next match in opposite direction + + + + / + search backwards for a regular expression + + + + \ + toggle search pattern coloring + + + + ! + invoke a command in a subshell + + + + V + show the Madmutt version number and date + + + + S + skip beyond quoted text + + + + $ + save changes to mailbox + + + + t + tag a message + + + + T + toggle display of quoted text + + + + ^ + jump to the top of the message + + + + u + undelete the current entry + + + + u + undelete all messages in subthread + + + + U + undelete all messages in thread + + + + v + show MIME attachments + + + +
+
@@ -265,12 +978,36 @@ - - search / search for a regular expression - search-next n search for next match - search-reverse ESC / search backwards for a regular - expression - + + Reference: Default Alias Menu Function Bindings + + + + Function + Default Key + Description + + + + + + / + search for a regular expression + + + + n + search for next match + + + + / + search backwards for a regular expression + + + +
+
@@ -281,19 +1018,61 @@ - - create-alias a create an alias from a message - sendermail m compose a new mail message - query Q query external program for addresses - query-append A append new query results to current - results - search / search for a regular expression - search-next n search for next match - search-opposite not bound search for next match in opposite - direction - search-reverse ESC / search backwards for a regular - expression - + + Reference: Default Query Menu Function Bindings + + + + Function + Default Key + Description + + + + + + a + create an alias from a message sender + + + + m + compose a new mail message + + + + Q + query external program for addresses + + + + A + append new query results to current results + + + + / + search for a regular expression + + + + n + search for next match + + + + + search for next match in opposite direction + + + + / + search backwards for a regular expression + + + +
+
@@ -304,31 +1083,111 @@ - - bounce-message b remail a message to another user - collapse-parts v toggle display of subparts - delete-entry d delete the current entry - display-toggle-weed h display message and toggle header - weeding - edit-type ^E edit the current entry's - Content-Typeextract-keys ^K extract PGP public keys - forward-message f forward a message with comments - group-reply g reply to all recipients - list-reply L reply to specified mailing list - pipe-entry | pipe message/attachment to a shell - command - print-entry p print the current entry - reply r reply to a message - resend-message ESC e resend message and preserve MIME - structure - save-entry s save message/attachment to a file - undelete-entry u undelete the current entry - view-attach RET view attachment using mailcap entry - if necessary - view-mailcap m force viewing of attachment using - mailcap - view-text T view attachment as text - + + Reference: Default Attachment Menu Function Bindings + + + + Function + Default Key + Description + + + + + + b + remail a message to another user + + + + v + toggle display of subparts + + + + d + delete the current entry + + + + h + display message and toggle header weeding + + + + E + edit the current entry's Content-Type + + + + K + extract PGP public keys + + + + f + forward a message with comments + + + + g + reply to all recipients + + + + L + reply to specified mailing list + + + + | + pipe message/attachment to a shell command + + + + p + print the current entry + + + + r + reply to a message + + + + e + resend message and preserve MIME structure + + + + s + save message/attachment to a file + + + + u + undelete the current entry + + + + Return + view attachment using mailcap entry if necessary + + + + m + force viewing of attachment using mailcap + + + + T + view attachment as text + + + +
+
@@ -339,48 +1198,186 @@ - - attach-file a attach a file(s) to this message - attach-message A attach message(s) to this message - attach-key ESC k attach a PGP public key - copy-file C save message/attachment to a file - detach-file D delete the current entry - display-toggle-weed h display message and toggle header - weeding - edit-bcc b edit the BCC list - edit-cc c edit the CC list - edit-description d edit attachment description - edit-encoding ^E edit attachment transfer-encoding - edit-fcc f enter a file to save a copy of this - message in - edit-from ESC f edit the from: field - edit-file ^X e edit the file to be attached - edit-headers E edit the message with headers - edit e edit the message - edit-mime m edit attachment using mailcap entry - edit-reply-to r edit the Reply-To field - edit-subject s edit the subject of this message - edit-to t edit the TO list - edit-type ^T edit attachment type - filter-entry F filter attachment through a shell - command - forget-passphrase ^F wipe PGP passphrase from memory - ispell i run ispell on the message - new-mime n compose new attachment using mailcap - entry - pgp-menu p show PGP options - pipe-entry | pipe message/attachment to a shell - command - postpone-message P save this message to send later - print-entry l print the current entry - rename-file R rename/move an attached file - send-message y send the message - toggle-unlink u toggle whether to delete file after - sending it - view-attach RET view attachment using mailcap entry - if necessary - write-fcc w write the message to a folder - + + Reference: Default Compose Menu Function Bindings + + + + Function + Default Key + Description + + + + + + a + attach a file(s) to this message + + + + A + attach message(s) to this message + + + + k + attach a PGP public key + + + + C + save message/attachment to a file + + + + D + delete the current entry + + + + h + display message and toggle header weeding + + + + b + edit the BCC list + + + + c + edit the CC list + + + + d + edit attachment description + + + + E + edit attachment transfer-encoding + + + + f + enter a file to save a copy of this message in + + + + f + edit the from: field + + + + X e + edit the file to be attached + + + + E + edit the message with headers + + + + e + edit the message + + + + m + edit attachment using mailcap entry + + + + r + edit the Reply-To field + + + + s + edit the subject of this message + + + + t + edit the TO list + + + + T + edit attachment type + + + + F + filter attachment through a shell command + + + + F + wipe PGP passphrase from memory + + + + i + run ispell on the message + + + + n + compose new attachment using mailcap entry + + + + p + show PGP options + + + + | + pipe message/attachment to a shell command + + + + P + save this message to send later + + + + l + print the current entry + + + + R + rename/move an attached file + + + + y + send the message + + + + u + toggle whether to delete file after sending it + + + + Return + view attachment using mailcap entry if necessary + + + + w + write the message to a folder + + + +
+
@@ -391,10 +1388,31 @@ - - delete-entry d delete the current entry - undelete-entry u undelete the current entry - + + Reference: Default Postpone Menu Function Bindings + + + + Function + Default Key + Description + + + + + + d + delete the current entry + + + + u + undelete the current entry + + + +
+
@@ -405,27 +1423,91 @@ - - change-dir c change directories - check-new TAB check mailboxes for new mail - enter-mask m enter a file mask - search / search for a regular expression - search-next n search for next match - search-reverse ESC / search backwards for a regular - expression - select-new N select a new file in this directory - sort o sort messages - sort-reverse O sort messages in reverse order - toggle-mailboxes TAB toggle whether to browse mailboxes - or all files - view-file SPACE view file - subscribe s subscribe to current mailbox (IMAP - Only) - unsubscribe u unsubscribe to current mailbox (IMAP - Only) - toggle-subscribed T toggle view all/subscribed mailboxes - (IMAP Only) - + + Reference: Default Browser Menu Function Bindings + + + + Function + Default Key + Description + + + + + + c + change directories + + + + Tab + check mailboxes for new mail + + + + m + enter a file mask + + + + / + search for a regular expression + + + + n + search for next match + + + + / + search backwards for a regular expression + + + + N + select a new file in this directory + + + + o + sort messages + + + + O + sort messages in reverse order + + + + Tab + toggle whether to browse mailboxes or all files + + + + Space + view file + + + + s + subscribe to current mailbox (IMAP Only) + + + + u + unsubscribe to current mailbox (IMAP Only) + + + + T + toggle view all/subscribed mailboxes (IMAP Only) + + + +
+
@@ -436,10 +1518,31 @@ - - view-name % view the key's user id - verify-key c verify a PGP public key - + + Reference: Default PGP Menu Function Bindings + + + + Function + Default Key + Description + + + + + + % + view the key's user id + + + + c + verify a PGP public key + + + +
+
@@ -450,52 +1553,193 @@ - - backspace BackSpace delete the char in front of the - cursor - backward-char ^B move the cursor one character to the - left - backward-word ESC b move the cursor to the previous word - bol ^A jump to the beginning of the line - buffy-cycle Space cycle among incoming mailboxes - capitalize-word ESC c uppercase the first character in the - word - complete TAB complete filename or alias - complete-query ^T complete address with query - delete-char ^D delete the char under the cursor - downcase-word ESC l lowercase all characters in current - word - eol ^E jump to the end of the line - forward-char ^F move the cursor one character to the - right - forward-word ESC f move the cursor to the next word - history-down not bound scroll down through the history list - history-up not bound scroll up through the history list - kill-eol ^K delete chars from cursor to end of - line - kill-eow ESC d delete chars from cursor to end of - word - kill-line ^U delete all chars on the line - kill-word ^W delete the word in front of the - cursor - quote-char ^V quote the next typed key - transpose-chars not bound transpose character under cursor - with previous - upcase-word ESC u uppercase all characters in current - word - + + Reference: Default Editor Function Bindings + + + + Function + Default Key + Description + + + + + + BackSpace + delete the char in front of the cursor + + + + B + move the cursor one character to the left + + + + b + move the cursor to the previous word + + + + A + jump to the beginning of the line + + + + Space + cycle among incoming mailboxes + + + + c + uppercase the first character in the word + + + + Tab + complete filename or alias + + + + T + complete address with query + + + + D + delete the char under the cursor + + + + l + lowercase all characters in current word + + + + E + jump to the end of the line + + + + F + move the cursor one character to the right + + + + f + move the cursor to the next word + + + + + scroll down through the history list + + + + + scroll up through the history list + + + + K + delete chars from cursor to end of line + + + + d + delete chars from cursor to end of word + + + + U + delete all chars on the line + + + + W + delete the word in front of the cursor + + + + V + quote the next typed key + + + + + transpose character under cursor with previous + + + + u + uppercase all characters in current word + + + +
+
- + + + sidebar + + + + Referene: Default Sidebar Function Bindings + + + + Key + Function + Description + + + + + + + Scrolls the mailbox list up 1 page + + + + + Scrolls the mailbox list down 1 page + + + + + Highlights the next mailbox + + + + + Highlights the next mailbox with new mail + + + + + Highlights the previous mailbox + + + + + Opens the currently highlighted mailbox + + + +
+
+ +
+ - - - + Acknowledgments @@ -517,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 @@ -626,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 @@ -638,7 +1883,7 @@ - Mutt-ng is developed by the following people: + Madmutt is developed by the following people: @@ -657,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): @@ -683,14 +1928,15 @@ - + - + Hacking Documentation 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. @@ -702,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). @@ -712,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 @@ -720,63 +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=""/> + <madmutt-doc:pattern name="" [full="1"]/> - References to configuration - commands. The name is given via the - name parameter and will be - auto-indexed under Configuration - Commands. + 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. If the + full parameter is given the equal sign as well + as tilde will be printed for a fully complete reference. - <muttng-doc:pattern name=""/> + <madmutt-doc:key [mod="C|E"]>key</madmutt-doc:key> - 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. + 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. - <muttng-doc:funcdef name="" key=""/> + <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 @@ -784,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="" link=""/> + <madmutt-doc:varref name=""/> References to variables. This practically is the same as above except that the text @@ -807,10 +2055,94 @@ manual use. + + <madmutt-doc:web url""/> + + Pretty print a linked URL. As for + E-Mail addresses where the text (mostly) equals the + link's target, URLs must be enclosed in + <> (also this reduced redudant + URL typing). + + + + <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 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. + + + + + +