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