vim: add a helpful header to notmuch-compose mode

[notmuch] / vim / README

diff --git a/vim/README b/vim/README
index 1ed2c4248337328e2cae6c5e66029ff3123b5b9a..02bd3e65ac4d345d4a931c6007f4fbfef866e8f8 100644 (file)
--- a/vim/README
+++ b/vim/README
@@ -3,27 +3,60 @@ through vim.
 
 NOTE: this is a work in progress.  Patches welcome. <bart@jukie.net>
 
+The vim interface makes use of the git-diff.vim syntax file which is
+available from
+    http://github.com/motemen/git-vim/blob/master/syntax/git-diff.vim
+
+
 To install:
         make install
 
+
 To run:
         vim -c ':NotMuch'
 
     from vim:
         :NotMuch
 
+
 Buffer types:
+    [notmuch-folders]
+        Folder list, or technically a list of saved searches.
+
+        Keybindings:
+            <Enter> - show the selected search
+            s       - enter search criteria
+            =       - refresh display
+
     [notmuch-search]
         You are presented with the search results when you run :NotMuch.
 
         Keybindings:
             <Enter> - show the selected message
-            s       - alter search criteria
+            a       - archive message (remove inbox tag)
+            f       - filter the current search terms
+            o       - toggle search screen order
+            s       - enter search criteria
+            es      - alter search criteria
+            t       - filter the current search terms with tags
+            q       - return to folder display, or undo filter
+            +       - add tag(s) to selected message
+            -       - remove tag(s) from selected message
+            =       - refresh display
+            ?       - reveal the thread ID of what's under cursor
+            ^]      - search using word under cursor
 
     [notmuch-show]
         This is the display of the message.
 
         Keybindings:
-            q       - return to search display
             ^n      - next message
+            ^p      - previous message
+            b       - toggle folding of message bodies
+            c       - toggle folding of citations
+            h       - toggle folding of extra header lines
+            s       - toggle folding of signatures
+            q       - return to search display
+            ?       - reveal the message and thread IDs of what's under cursor
+            ^]      - search using word under cursor