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