vim: added searching for word under cursor with ^]
[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             S       - 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             ^]      - search using word under cursor
40
41     [notmuch-show]
42         This is the display of the message.
43
44         Keybindings:
45             ^n      - next message
46             ^p      - previous message
47             b       - toggle folding of message bodies
48             c       - toggle folding of citations
49             h       - toggle folding of extra header lines
50             s       - toggle folding of signatures
51             q       - return to search display
52             ^]      - search using word under cursor
53