test: save buffer content to file instead of printing it in Emacs tests
[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     mailx:
11         To send mail, notmuch.vim uses the UNIX mailx command.
12
13
14 To install:
15         make install
16
17
18 To run:
19         vim -c ':NotMuch'
20
21     from vim:
22         :NotMuch
23         :NotMuch new to:bart@jukie.net 'subject:this is a test'
24
25
26 Buffer types:
27     [notmuch-folders]
28         Folder list, or technically a list of saved searches.
29
30         Keybindings:
31             <Enter> - show the selected search
32             m       - compose a new message
33             s       - enter search criteria
34             =       - refresh display
35
36     [notmuch-search]
37         You are presented with the search results when you run :NotMuch.
38
39         Keybindings:
40             <Space> - show the selected thread collapsing unmatched items
41             <Enter> - show the entire selected thread
42             a       - archive message (remove inbox tag)
43             f       - filter the current search terms
44             o       - toggle search screen order
45             m       - compose a new message
46             r       - reply to thread
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             i       - toggle folding of signatures
68             m       - compose a new message
69             r       - reply to the message
70             s       - enter search criteria
71             q       - return to search display
72             ?       - reveal the message and thread IDs of what's under cursor
73             ^]      - search using word under cursor
74
75     [notmuch-compose]
76         When you're writing an email, you're in this mode.
77
78         Insert-mode keybindings:
79             <Tab>   - go to the next header line
80
81         Normal-mode keybindings:
82             <Tab>   - go to the next header line
83             ,s      - send this message
84             ,q      - abort this message
85