add notmuch-folders support mode
[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 To install:
7         make install
8
9 To run:
10         vim -c ':NotMuch'
11
12     from vim:
13         :NotMuch
14
15 Buffer types:
16     [notmuch-folders]
17         Folder list, or technically a list of saved searches.
18
19         Keybindings:
20             <Enter> - show the selected search
21
22     [notmuch-search]
23         You are presented with the search results when you run :NotMuch.
24
25         Keybindings:
26             <Enter> - show the selected message
27             a       - archive message (remove inbox tag)
28             f       - filter the current search terms
29             o       - toggle search screen order
30             s       - enter search criteria
31             S       - alter search criteria
32             t       - filter the current search terms with tags
33             q       - return to folder display, or undo filter
34             +       - add tag(s) to selected message
35             -       - remove tag(s) from selected message
36             =       - refresh display
37
38     [notmuch-show]
39         This is the display of the message.
40
41         Keybindings:
42             ^n      - next message
43             ^p      - previous message
44             b       - toggle folding of message bodies
45             c       - toggle folding of citations
46             h       - toggle folding of extra header lines
47             s       - toggle folding of signatures
48             q       - return to search display
49