vim: few compose mode updates, including README
[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             <Enter> - show the selected message
46             a       - archive message (remove inbox tag)
47             f       - filter the current search terms
48             o       - toggle search screen order
49             m       - compose a new message
50             s       - enter search criteria
51             ,s      - alter search criteria
52             t       - filter the current search terms with tags
53             q       - return to folder display, or undo filter
54             +       - add tag(s) to selected message
55             -       - remove tag(s) from selected message
56             =       - refresh display
57             ?       - reveal the thread ID of what's under cursor
58             ^]      - search using word under cursor
59
60     [notmuch-show]
61         This is the display of the message.
62
63         Keybindings:
64             <Space> - mark read, archive, go to next matching message
65             ^n      - next message
66             ^p      - previous message
67             b       - toggle folding of message bodies
68             c       - toggle folding of citations
69             h       - toggle folding of extra header lines
70             m       - compose a new message
71             s       - toggle folding of signatures
72             q       - return to search display
73             ?       - reveal the message and thread IDs of what's under cursor
74             ^]      - search using word under cursor
75
76     [notmuch-compose]
77         When you're writing an email, you're in this mode.
78
79         Insert-mode keybindings:
80             <Tab>   - go to the next header line
81
82         Normal-mode keybindings:
83             <Tab>   - go to the next header line
84             ,s      - send this message
85             ,q      - abort this message
86