notmuch/contrib/notmuch-vim/README
David Bremner 6ee07a9c6d notmuch-vim: deprecate, move to contrib
As discussed in id:871udhcmks.fsf@zancas.localnet, notmuch-vim doesn't
really meet the standards of the CLI, emacs interface, or python
bindings in terms of being well maintained.
2013-02-16 08:03:09 -04:00

86 lines
2.9 KiB
Text

This directory contains a vim script that allows reading notmuch mail
through vim.
NOTE: this is a work in progress. Patches welcome. <bart@jukie.net>
Dependencies:
notmuch:
Naturally, it expects you have notmuch installed and configured.
sendmail:
To send mail, notmuch.vim uses sendmail as default. Most modern MTAs
provide a compatibility binary, and so should work well.
To install:
make install
To run:
vim -c ':NotMuch'
from vim:
:NotMuch
:NotMuch new to:bart@jukie.net 'subject:this is a test'
Buffer types:
[notmuch-folders]
Folder list, or technically a list of saved searches.
Keybindings:
<Enter> - show the selected search
m - compose a new message
s - enter search criteria
= - refresh display
[notmuch-search]
You are presented with the search results when you run :NotMuch.
Keybindings:
<Space> - show the selected thread collapsing unmatched items
<Enter> - show the entire selected thread
a - archive message (remove inbox tag)
f - filter the current search terms
o - toggle search screen order
m - compose a new message
r - reply to thread
s - enter search criteria
,s - alter search criteria
t - filter the current search terms with tags
q - return to folder display, or undo filter
+ - add tag(s) to selected message
- - remove tag(s) from selected message
= - refresh display
? - reveal the thread ID of what's under cursor
^] - search using word under cursor
[notmuch-show]
This is the display of the message.
Keybindings:
<Space> - mark read, archive, go to next matching message
^n - next message
^p - previous message
b - toggle folding of message bodies
c - toggle folding of citations
h - toggle folding of extra header lines
i - toggle folding of signatures
m - compose a new message
r - reply to the message
s - enter search criteria
q - return to search display
? - reveal the message and thread IDs of what's under cursor
^] - search using word under cursor
[notmuch-compose]
When you're writing an email, you're in this mode.
Insert-mode keybindings:
<Tab> - go to the next header line
Normal-mode keybindings:
<Tab> - go to the next header line
,s - send this message
,q - abort this message