emacs: notmuch-jump.el should provide.
[notmuch] / contrib / notmuch-vim / README
1 This directory contains a vim script that allows reading notmuch mail
2 through vim.
3
4 NOTE: this is a work in progress.  Patches welcome. <bart@jukie.net>
5
6 Dependencies:
7     notmuch:
8         Naturally, it expects you have notmuch installed and configured.
9
10     sendmail:
11         To send mail, notmuch.vim uses sendmail as default.  Most modern MTAs
12         provide a compatibility binary, and so should work well.
13
14
15 To install:
16         make install
17
18
19 To run:
20         vim -c ':NotMuch'
21
22     from vim:
23         :NotMuch
24         :NotMuch new to:bart@jukie.net 'subject:this is a test'
25
26
27 Buffer types:
28     [notmuch-folders]
29         Folder list, or technically a list of saved searches.
30
31         Keybindings:
32             <Enter> - show the selected search
33             m       - compose a new message
34             s       - enter search criteria
35             =       - refresh display
36
37     [notmuch-search]
38         You are presented with the search results when you run :NotMuch.
39
40         Keybindings:
41             <Space> - show the selected thread collapsing unmatched items
42             <Enter> - show the entire selected thread
43             a       - archive message (remove inbox tag)
44             f       - filter the current search terms
45             o       - toggle search screen order
46             m       - compose a new message
47             r       - reply to thread
48             s       - enter search criteria
49             ,s      - alter search criteria
50             t       - filter the current search terms with tags
51             q       - return to folder display, or undo filter
52             +       - add tag(s) to selected message
53             -       - remove tag(s) from selected message
54             =       - refresh display
55             ?       - reveal the thread ID of what's under cursor
56             ^]      - search using word under cursor
57
58     [notmuch-show]
59         This is the display of the message.
60
61         Keybindings:
62             <Space> - mark read, archive, go to next matching message
63             ^n      - next message
64             ^p      - previous message
65             b       - toggle folding of message bodies
66             c       - toggle folding of citations
67             h       - toggle folding of extra header lines
68             i       - toggle folding of signatures
69             m       - compose a new message
70             r       - reply to the message
71             s       - enter search criteria
72             q       - return to search display
73             ?       - reveal the message and thread IDs of what's under cursor
74             ^]      - search using word under cursor
75
76     [notmuch-compose]
77         When you're writing an email, you're in this mode.
78
79         Insert-mode keybindings:
80             <Tab>   - go to the next header line
81
82         Normal-mode keybindings:
83             <Tab>   - go to the next header line
84             ,s      - send this message
85             ,q      - abort this message
86