Merge remote branch 'jukie/vim'
[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         :NotMuch new to:bart@jukie.net 'subject:this is a test'
29
30
31 Buffer types:
32     [notmuch-folders]
33         Folder list, or technically a list of saved searches.
34
35         Keybindings:
36             <Enter> - show the selected search
37             m       - compose a new message
38             s       - enter search criteria
39             =       - refresh display
40
41     [notmuch-search]
42         You are presented with the search results when you run :NotMuch.
43
44         Keybindings:
45             <Space> - show the selected thread colapsing unmatched items
46             <Enter> - show the entire selected thread
47             a       - archive message (remove inbox tag)
48             f       - filter the current search terms
49             o       - toggle search screen order
50             m       - compose a new message
51             r       - reply to thread
52             s       - enter search criteria
53             ,s      - alter search criteria
54             t       - filter the current search terms with tags
55             q       - return to folder display, or undo filter
56             +       - add tag(s) to selected message
57             -       - remove tag(s) from selected message
58             =       - refresh display
59             ?       - reveal the thread ID of what's under cursor
60             ^]      - search using word under cursor
61
62     [notmuch-show]
63         This is the display of the message.
64
65         Keybindings:
66             <Space> - mark read, archive, go to next matching message
67             ^n      - next message
68             ^p      - previous message
69             b       - toggle folding of message bodies
70             c       - toggle folding of citations
71             h       - toggle folding of extra header lines
72             i       - toggle folding of signatures
73             m       - compose a new message
74             r       - reply to the message
75             s       - enter search criteria
76             q       - return to search display
77             ?       - reveal the message and thread IDs of what's under cursor
78             ^]      - search using word under cursor
79
80     [notmuch-compose]
81         When you're writing an email, you're in this mode.
82
83         Insert-mode keybindings:
84             <Tab>   - go to the next header line
85
86         Normal-mode keybindings:
87             <Tab>   - go to the next header line
88             ,s      - send this message
89             ,q      - abort this message
90