Functions
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 bind
command.
generic
The generic menu is not a real menu, but
specifies common functions
(such as movement) available in all menus except for pager and
editor. Changing settings for this menu will
affect the default
bindings for all menus (except as noted).
Reference: Default Generic Function BindingsFunctionDefault KeyDescriptionLmove to the bottom of the pagemove current entry to bottom of pagemove current entry to middle of pagemove current entry to top of page:enter a madmuttrc commandqexit this menu=move to the first entry]scroll down 1/2 page[scroll up 1/2 page?this screennumberjump to an index number*move to the last entryMmove to the middle of the pagejmove to the next entry>scroll down one linezmove to the next pagekmove to the previous entry>scroll up one lineZmove to the previous pagecycle through all defined mailboxes to rebuild all header cachesLclear and redraw the screen/search for a regular expressionnsearch for next matchsearch for next match in opposite direction/search backwards for a regular expressionReturnselect the current entry!run a program in a subshellttoggle the tag on the current entry;apply next command to tagged entriesapply next function ONLY to tagged messagesHmove to the top of the pagedisplay the keycode for a key press
index
Reference: Default Index Function BindingsFunctionDefault KeyDescriptionbremail a message to another usercopen a different foldercopen a different folder in read only modePcheck for classic pgpWclear a status flag from a messageCcopy a message to a file/mailboxacreate an alias from a message senderCdecode a message and copy it to a file/mailboxsdecode a message and save it to a file/mailboxddelete the current entryDdelete messages matching a patternddelete all messages in subthreadDdelete all messages in thread@display full address of senderhdisplay message and toggle header weedingReturndisplay a messageeedit the current messageEedit the current message's Content-Typexexit without saving changesKextract PGP public keysGretrieve mail from POP serverFtoggle a message's 'important' flagFwipe PGP passphrase from memoryfforward a message with commentsgreply to all recipientslshow only messages matching a patternLreply to specified mailing listmcompose a new mail messagekmail a PGP public keyjump to the next new messageTabjump to the next new or unread messagenjump to the next subthreadNjump to the next threadjmove to the next undeleted messagejump to the next unread messagePjump to parent message in thread |pipe message/attachment to a shell commandjump to the previous new messageTabjump to the previous new or unread messageZmove to the previous pagepjump to previous subthreadPjump to previous threadkmove to the last undelete messagejump to the previous unread messagepprint the current entryQquery external program for addressesqsave changes to mailbox and quitrmark the current subthread as readRmark the current thread as readRrecall a postponed messagerreply to a messageeresend message and preserve MIME structuressave message/attachment to a filewset a status flag on a messageVshow the Madmutt version number and datelshow currently active limit pattern, if anyosort messagesOsort messages in reverse order$save changes to mailboxTtag messages matching a patternttag/untag all messages in the current threadNtoggle a message's 'new' flag%toggle whether the mailbox will be rewrittenuundelete the current entryUundelete messages matching a patternuundelete all messages in subthreadUundelete all messages in threadTuntag messages matching a patternvshow MIME attachments
pager
Reference: Default Pager Function BindingsFunctionDefault KeyDescriptionjump to the bottom of the messagebremail a message to another usercopen a different foldercopen a different folder in read only modePcheck for classic pgpCcopy a message to a file/mailboxacreate an alias from a messageCdecode a message and copy it to a file/mailboxsdecode a message and save it to a file/mailboxddelete the current entryddelete all messages in subthreadDdelete all messages in thread@display full address of senderhdisplay message and toggle header weedingeedit the current messageEedit the current message's Content-Type:enter a madmuttrc commandireturn to the main-menuKextract PGP public keysFtoggle a message's 'important' flagFwipe PGP passphrase from memoryfforward a message with commentsgreply to all recipientsmove up one-half pagemove down one-half page?this screenLreply to specified mailing listmcompose a new mail messagekmail a PGP public keyNtoggle a message's 'new' flagReturnscroll down one lineJmove to the next entryjump to the next new messageTabjump to the next new or unread messagemove to the next pagenjump to the next subthreadNjump to the next threadjmove to the next undeleted messagejump to the next unread messagePjump to parent message in thread|pipe message/attachment to a shell commandBackSpacescroll up one lineKmove to the previous entryjump to the previous new messagejump to the previous new or unread message-move to the previous pagepjump to previous subthreadPjump to previous threadkmove to the last undelete messagejump to the previous unread messagepprint the current entryQsave changes to mailbox and quitrmark the current subthread as readRmark the current thread as readRrecall a postponed messageLclear and redraw the screenrreply to a messagessave message/attachment to a file/search for a regular expressionnsearch for next matchsearch for next match in opposite direction/search backwards for a regular expression\toggle search pattern coloring!invoke a command in a subshellVshow the Madmutt version number and dateSskip beyond quoted text$save changes to mailboxttag a messageTtoggle display of quoted text^jump to the top of the messageuundelete the current entryuundelete all messages in subthreadUundelete all messages in threadvshow MIME attachments
alias
Reference: Default Alias Menu Function BindingsFunctionDefault KeyDescription/search for a regular expressionnsearch for next match/search backwards for a regular expression
query
Reference: Default Query Menu Function BindingsFunctionDefault KeyDescriptionacreate an alias from a message sendermcompose a new mail messageQquery external program for addressesAappend new query results to current results/search for a regular expressionnsearch for next matchsearch for next match in opposite direction/search backwards for a regular expression
attach
Reference: Default Attachment Menu Function BindingsFunctionDefault KeyDescriptionbremail a message to another uservtoggle display of subpartsddelete the current entryhdisplay message and toggle header weedingEedit the current entry's Content-TypeKextract PGP public keysfforward a message with commentsgreply to all recipientsLreply to specified mailing list|pipe message/attachment to a shell commandpprint the current entryrreply to a messageeresend message and preserve MIME structuressave message/attachment to a fileuundelete the current entryReturnview attachment using mailcap entry if necessarymforce viewing of attachment using mailcapTview attachment as text
compose
Reference: Default Compose Menu Function BindingsFunctionDefault KeyDescriptionaattach a file(s) to this messageAattach message(s) to this messagekattach a PGP public keyCsave message/attachment to a fileDdelete the current entryhdisplay message and toggle header weedingbedit the BCC listcedit the CC listdedit attachment descriptionEedit attachment transfer-encodingfenter a file to save a copy of this message infedit the from: fieldX eedit the file to be attachedEedit the message with headerseedit the messagemedit attachment using mailcap entryredit the Reply-To fieldsedit the subject of this messagetedit the TO listTedit attachment typeFfilter attachment through a shell commandFwipe PGP passphrase from memoryirun ispell on the messagencompose new attachment using mailcap entrypshow PGP options|pipe message/attachment to a shell commandPsave this message to send laterlprint the current entryRrename/move an attached fileysend the messageutoggle whether to delete file after sending itReturnview attachment using mailcap entry if necessarywwrite the message to a folder
postpone
Reference: Default Postpone Menu Function BindingsFunctionDefault KeyDescriptionddelete the current entryuundelete the current entry
browser
Reference: Default Browser Menu Function BindingsFunctionDefault KeyDescriptioncchange directoriesTabcheck mailboxes for new mailmenter a file mask/search for a regular expressionnsearch for next match/search backwards for a regular expressionNselect a new file in this directoryosort messagesOsort messages in reverse orderTabtoggle whether to browse mailboxes or all filesSpaceview filessubscribe to current mailbox (IMAP Only)uunsubscribe to current mailbox (IMAP Only)Ttoggle view all/subscribed mailboxes (IMAP Only)
pgp
Reference: Default PGP Menu Function BindingsFunctionDefault KeyDescription%view the key's user idcverify a PGP public key
editor
Reference: Default Editor Function BindingsFunctionDefault KeyDescriptionBackSpacedelete the char in front of the cursorBmove the cursor one character to the leftbmove the cursor to the previous wordAjump to the beginning of the lineSpacecycle among incoming mailboxescuppercase the first character in the wordTabcomplete filename or aliasTcomplete address with queryDdelete the char under the cursorllowercase all characters in current wordEjump to the end of the lineFmove the cursor one character to the rightfmove the cursor to the next wordscroll down through the history listscroll up through the history listKdelete chars from cursor to end of lineddelete chars from cursor to end of wordUdelete all chars on the lineWdelete the word in front of the cursorVquote the next typed keytranspose character under cursor with previousuuppercase all characters in current word
sidebar
Referene: Default Sidebar Function BindingsKeyFunctionDescriptionScrolls the mailbox list up 1 pageScrolls the mailbox list down 1 pageHighlights the next mailboxHighlights the next mailbox with new mailHighlights the previous mailboxOpens the currently highlighted mailbox
Acknowledgments
Kari Hurtta kari.hurtta@fmi.fi co-developed the
original MIME
>parsing code back in the ELM-ME days.
The following people have been very helpful to the development of
Mutt (sorted by surnames):
Vikas Agnihotri vikasa@writeme.com
Francois Berjon Francois.Berjon@aar.alcatel-alsthom.fr
Aric Blumer aric@fore.com
John Capo jc@irbs.com
David Champion dgc@uchicago.edu
Brendan Cully brendan@kublai.com
Liviu Daia daia@stoilow.imar.ro
Thomas E. Dickey dickey@herndon4.his.com
David DeSimone fox@convex.hp.com
Nickolay N. Dudorov nnd@wint.itfs.nsk.su
Ruslan Ermilov ru@freebsd.org
Edmund Grimley Evans edmundo@rano.org
Michael Finken finken@conware.de
Sven Guckes guckes@math.fu-berlin.de
Lars Hecking lhecking@nmrc.ie
Mark Holloman holloman@nando.net
Andreas Holzmann holzmann@fmi.uni-passau.de
Marco d'Itri md@linux.it
Björn Jacke bjacke@suse.com
Byrial Jensen byrial@image.dk
David Jeske jeske@igcom.net
Christophe Kalt kalt@hugo.int-evry.fr
Tommi Komulainen Tommi.Komulainen@iki.fi
Felix von Leitner (a.k.a ``Fefe'')
leitner@math.fu-berlin.de
Brandon Long blong@fiction.net
Jimmy Mäkeä jmy@flashback.net
Lars Marowsky-Bree lmb@pointer.in-minden.de
Thomas ``Mike'' Michlmayr mike@cosy.sbg.ac.at
Andrew W. Nosenko awn@bcs.zp.ua
David O'Brien obrien@Nuxi.cs.ucdavis.edu
Clint Olsen olsenc@ichips.intel.com
Park Myeong Seok pms@romance.kaist.ac.kr
Thomas Parmelan tom@ankh.fr.eu.org
Ollivier Robert roberto@keltia.freenix.fr
Thomas Roessler roessler@does-not-exist.org
Roland Rosenfeld roland@spinnaker.de
TAKIZAWA Takashi taki@luna.email.ne.jp
Allain Thivillon Allain.Thivillon@alma.fr
Gero Treuner gero@70t.de
Vsevolod Volkov vvv@lucky.net
Ken Weinert kenw@ihs.com
Madmutt is developed by the following people:
Andreas Krennmair ak@synflood.at
Nico Golde nico@ngolde.de
Rocco Rutte pdmef@cs.tu-berlin.de
The following people have been very helpful to the
development of Madmutt (sorted by surnames):
Christian Gall cg@cgall.de
Iain Lea iain@bricbrac.de
Andreas Kneib akneib@gmx.net
Felix Meinhold felix.meinhold@gmx.net
Carsten Schoelzki cjs@weisshuhn.de
Elimar Riesebieter riesebie@lxtec.deHacking Documentation
This manual is written in XML and transformed via a XSLT
stylesheet into valid DocBook/XML and/or to be again transformed via a
XSLT stylesheet into the final formats.
This two pass processing is required to keep the file size low
and to sanitize use, i.e. drastically lower the typing
overhead.
To achieve the latter, the sources come with a file called
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).
<madmutt-doc:man name="" [sect=""]/>References to manual pages. If the
sect parameter is omitted, it'll
be 1 for the commands section. There's no auto-indexing yet.
<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 is done.
<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.
<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. If the
full parameter is given the equal sign as well
as tilde will be printed for a fully complete reference.
<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. The default key
binding must be given via
<madmutt-doc:key/> (see above). The string
will be automatically enclosed in
<>. Auto-indexing is done.
Also an anchor with id
func-[name] will be added with
[name] being the value of the
name parameter.
<madmutt-doc:funcref name=""/>References to functions.. This is
practically the same as the above except that there's no
anchor defined.
<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. The
name parameter's value will be
prefixed with a dollar sign as for environment
variables.
<madmutt-doc:varref name=""/>References to variables. This
practically is the same as above except that the text
inbetween won't be wrapped within a
<sect1> tag. Auto-indexing is
the same as for the above. This one is intended for
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.