9f1ff57138e491526df7dcd337142be4714da7ae
[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             s       - enter search criteria
22             =       - refresh display
23
24     [notmuch-search]
25         You are presented with the search results when you run :NotMuch.
26
27         Keybindings:
28             <Enter> - show the selected message
29             a       - archive message (remove inbox tag)
30             f       - filter the current search terms
31             o       - toggle search screen order
32             s       - enter search criteria
33             es      - alter search criteria
34             t       - filter the current search terms with tags
35             q       - return to folder display, or undo filter
36             +       - add tag(s) to selected message
37             -       - remove tag(s) from selected message
38             =       - refresh display
39             ?       - reveal the thread ID of what's under cursor
40             ^]      - search using word under cursor
41
42     [notmuch-show]
43         This is the display of the message.
44
45         Keybindings:
46             ^n      - next message
47             ^p      - previous message
48             b       - toggle folding of message bodies
49             c       - toggle folding of citations
50             h       - toggle folding of extra header lines
51             s       - toggle folding of signatures
52             q       - return to search display
53             ?       - reveal the message and thread IDs of what's under cursor
54             ^]      - search using word under cursor
55