X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=vim%2FREADME;h=d8bea97f304bffb038a93dee9a071e63defefe45;hb=fd805c16c3fdcc4170a42d3cacb9b16cdfa11ff7;hp=31f1e20b1eb9a066db5e700dfa8926938768cfb0;hpb=e2006a2f3cd1bc47b45f2b880f4dd5ba775d1b3b;p=notmuch diff --git a/vim/README b/vim/README index 31f1e20b..d8bea97f 100644 --- a/vim/README +++ b/vim/README @@ -3,16 +3,39 @@ through vim. NOTE: this is a work in progress. Patches welcome. +Dependencies: + notmuch: + Naturally, it expects you have notmuch installed and configured. + + mail: + To send mail, notmuch.vim uses the UNIX mail command. + + git-diff: + 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: + - show the selected search + s - enter search criteria + = - refresh display + [notmuch-search] You are presented with the search results when you run :NotMuch. @@ -22,20 +45,27 @@ Buffer types: f - filter the current search terms o - toggle search screen order s - enter search criteria - S - alter search criteria - f - filter the current search terms with tags + ,s - 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: + - mark read, archive, go to next matching message ^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