vim: add git-diff.vim in README, make syntax work w/o the script
[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 The vim interface makes use of the git-diff.vim syntax file which is
7 available from
8     http://github.com/motemen/git-vim/blob/master/syntax/git-diff.vim
9
10
11 To install:
12         make install
13
14
15 To run:
16         vim -c ':NotMuch'
17
18     from vim:
19         :NotMuch
20
21
22 Buffer types:
23     [notmuch-folders]
24         Folder list, or technically a list of saved searches.
25
26         Keybindings:
27             <Enter> - show the selected search
28             s       - enter search criteria
29             =       - refresh display
30
31     [notmuch-search]
32         You are presented with the search results when you run :NotMuch.
33
34         Keybindings:
35             <Enter> - show the selected message
36             a       - archive message (remove inbox tag)
37             f       - filter the current search terms
38             o       - toggle search screen order
39             s       - enter search criteria
40             es      - alter search criteria
41             t       - filter the current search terms with tags
42             q       - return to folder display, or undo filter
43             +       - add tag(s) to selected message
44             -       - remove tag(s) from selected message
45             =       - refresh display
46             ?       - reveal the thread ID of what's under cursor
47             ^]      - search using word under cursor
48
49     [notmuch-show]
50         This is the display of the message.
51
52         Keybindings:
53             ^n      - next message
54             ^p      - previous message
55             b       - toggle folding of message bodies
56             c       - toggle folding of citations
57             h       - toggle folding of extra header lines
58             s       - toggle folding of signatures
59             q       - return to search display
60             ?       - reveal the message and thread IDs of what's under cursor
61             ^]      - search using word under cursor
62