LOGO
+++
+++
*All mail clients suck. Mutt just sucks less. This one just sucks less than
mutt.*
++++++
section:Introduction[intro]
http://muttator.mozdev.org[Muttator] is a free browser add-on for Thunderbird,
which makes it look and behave like the http://www.vim.org[Vim]
text editor. It has similar key bindings, and you could call it a modal
mail client, as key bindings differ according to which mode you are in.
|warning| +
Warning:
To provide the most authentic Vim experience, the Thunderbird menubar and toolbar were hidden. +
If you really need them, type: [c]:set guioptions+=mT[c] to get them back. +
If you don't like Muttator at all, you can uninstall it by typing
[c]:addons[c] and remove/disable it. +
If you like it, but can't remember the shortcuts, press [m]F1[m] or
[c]:help[c] to get this help window back.
|author| |donation| +
Muttator was written by mailto:stubenschrott@vimperator.org[Martin Stubenschrott].
If you appreciate my work on Muttator and want to encourage me working on it
more, you can either send me greetings, patches or make a donation:
NOTE: If this link does not work, go to http://muttator.mozdev.org and click
the donation button there, because Thunderbird seems to have a problem when
this link is inside an e-mail (which this help screen actually is).
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Of course as a believer in free open source software, only make a donation
if you really like Muttator and the money doesn't hurt -- otherwise just use
it, recommend it and like it :)
section:Help{nbsp}topics[overview]
TO BE WRITTEN...
For now use [c]:viusage![c], [c]:exusage![c] and [c]:optionusage![c] to find
out about available mappings, commands and options. When in Message mode
(activated by [m]i[m]), most mappings from Vimperator are available.
// - help:Initialization[starting.html]: How vimperator starts up, where it reads the config file...
// - help:Browsing[browsing.html]: Basic mappings and commands needed for
// a browsing session (how to open a web page or go back in history).
// - help:Motion{nbsp}commands[motion.html]: How to efficiently scroll in
// Vimperator.
// - help:Options[options.html]: A description of all options.
// - help:Tabs[tabs.html]: Manage your tabbed browsing session.
// - help:Marks[marks.html]: Usage of bookmarks, QuickMarks, and history.
// - help:Repeating{nbsp}commands[repeat.html]: Usage of macros to repeat
// recurring workflows.
// - help:Autocommands[autocommands.html]: Automatically execute code on ceratain
// events.
// - help:Developer{nbsp}Information[developer.html]: How to write docs or
// plugins.
// - help:Various[various.html]: Other help which didn't fit into any other category.
You can also jump directly to the help of a specific command with [c]:help
o[c] or [c]:help :set[c].
section:Features[features]
* Vim-like keybindings ([m]h[m], [m]j[m], [m]k[m], [m]l[m],
[m]gg[m], [m]G[m], [m]0[m], [m]$[m], [m]ZZ[m], [m][m], etc.)
* Ex-commands ([c]:quit[c], [c]:goto Inbox[c], ...)
* Tab completion available for all commands with support for 'longest' matching when set in 'wildmode'
* Hit-a-hint like navigation of links (start with [m]f[m] to follow a link)
* Minimal GUI (easily hide useless menubar and toolbar with [c]:set guioptions=f[c])
* Ability to [c]:source[c] javascript files, and to use a [a]~/.muttatorrc[a] file
* Count supported for many commands ([m]3[m] will go back 3 messages)
* Beep on errors
* [c]:map[c] support (and feedkeys() for script writers)
* [c]:time[c] support for profiling
* Many other vimperator features are available when in -- MESSAGE -- mode
// * A comprehensive help file, explaining all commands, mappings and options.
section:Contact[contact]
Please send comments/bug reports/patches to the mailing list, where I will
properly answer any questions. You can also join the #vimperator IRC channel
on irc.freenode.net or check the Wiki for frequently asked questions. Make
sure, you have read the TODO file first, as I am aware of many things which
can be improved when I find time for it or get patches.
// vim: set filetype=asciidoc: