From: Felipe Contreras Date: Sat, 2 Nov 2013 13:47:12 +0000 (-0600) Subject: vim: add help file X-Git-Tag: 0.17_rc1~6 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=42ff2d3a0d899d3ec64787d3eff31ad8c74b1103;p=notmuch.git vim: add help file Signed-off-by: Felipe Contreras --- diff --git a/debian/notmuch-vim.dirs b/debian/notmuch-vim.dirs index c978ac11..c6373e42 100644 --- a/debian/notmuch-vim.dirs +++ b/debian/notmuch-vim.dirs @@ -1,3 +1,4 @@ usr/share/vim/registry usr/share/vim/addons/plugin +usr/share/vim/addons/doc usr/share/vim/addons/syntax diff --git a/debian/notmuch-vim.install b/debian/notmuch-vim.install index d444fef7..a1af708d 100644 --- a/debian/notmuch-vim.install +++ b/debian/notmuch-vim.install @@ -1,3 +1,4 @@ vim/notmuch.vim usr/share/vim/addons/plugin +vim/notmuch.txt usr/share/vim/addons/doc vim/syntax/notmuch-*.vim usr/share/vim/addons/syntax vim/notmuch.yaml usr/share/vim/registry diff --git a/vim/Makefile b/vim/Makefile index bb3ec608..b6f9db78 100644 --- a/vim/Makefile +++ b/vim/Makefile @@ -8,6 +8,7 @@ all: install: $(INSTALL) $(CURDIR)/notmuch.vim $(D)$(prefix)/plugin/notmuch.vim + $(INSTALL) $(CURDIR)/notmuch.txt $(D)$(prefix)/doc/notmuch.txt @$(foreach file,$(wildcard syntax/*), \ $(INSTALL) $(CURDIR)/$(file) $(D)$(prefix)/$(file);) diff --git a/vim/notmuch.txt b/vim/notmuch.txt new file mode 100644 index 00000000..43741022 --- /dev/null +++ b/vim/notmuch.txt @@ -0,0 +1,153 @@ +*notmuch.txt* Plug-in to make vim a nice email client using notmuch + +Author: Felipe Contreras + +Overview |notmuch-intro| +Usage |notmuch-usage| +Mappings |notmuch-mappings| +Configuration |notmuch-config| + +============================================================================== +OVERVIEW *notmuch-intro* + +This is a vim plug-in that provides a fully usable mail client interface, +utilizing the notmuch framework. + +It has three main views: folders, search, and thread. In the folder view you +can find a summary of saved searches, In the search view you can see all the +threads that comprise the selected search, and in the thread view you can read +every mail in the thread. + +============================================================================== +USAGE *notmuch-usage* + +To use it, simply run the `:NotMuch` command. + +By default you start in the folder view which shows you default searches and +the number of threads that match those: +> + 10 new (tag:inbox and tag:unread) + 20 inbox (tag:inbox) + 30 unread (tag:unread) +< +You can see the threads of each by clicking `enter`, which sends you to the +search view. In both the search and folder views you can type `s` to type a +new search, or `=` to refresh. To see a thread, type `enter` again. + +To exit a view, click `q`. + +Also, you can specify a search directly: +> + :NotMuch is:inbox and date:yesterday.. +< +============================================================================== +MAPPINGS *notmuch-mappings* + +------------------------------------------------------------------------------ +Folder view~ + + Show selected search +s Enter a new search += Refresh +c Compose a new mail + +------------------------------------------------------------------------------ +Search view~ + +q Quit view + Show selected search + Show selected search with filter +A Archive (-inbox -unread) +I Mark as read (-unread) +t Tag (prompted) +s Search += Refresh +? Show search information +c Compose a new mail +> +------------------------------------------------------------------------------ +Thread view~ + +q Quit view +A Archive (-inbox -unread) +I Mark as read (-unread) +t Tag (prompted) +s Search +p Save patches +r Reply +? Show thread information + Show next message +c Compose a new mail + +------------------------------------------------------------------------------ +Compose view~ + +q Quit view +s Send + +============================================================================== +CONFIGURATION *notmuch-config* + +You can add the following configurations to your `.vimrc`, or +`~/.vim/plugin/notmuch.vim`. + + *g:notmuch_folders* + +The first thing you might want to do is set your custom searches. +> + let g:notmuch_folders = [ + \ [ 'new', 'tag:inbox and tag:unread' ], + \ [ 'inbox', 'tag:inbox' ], + \ [ 'unread', 'tag:unread' ], + \ [ 'to-do', 'tag:to-do' ], + \ [ 'to-me', 'to:john.doe and tag:new' ], + \ ] +< + + *g:notmuch_custom_search_maps* + *g:notmuch_custom_show_maps* + +You can also configure the keyboard mappings for the different views: +> + let g:notmuch_custom_search_maps = { + \ 't': 'search_tag("+to-do -inbox")', + \ 'd': 'search_tag("+deleted -inbox -unread")', + \ } + + let g:notmuch_custom_show_maps = { + \ 't': 'show_tag("+to-do -inbox")', + \ 'd': 'show_tag("+deleted -inbox -unread")', + \ } +< + + *g:notmuch_date_format* + +To configure the date format you want in the search view: +> + let g:notmuch_date_format = '%d.%m.%y' +< + + *g:notmuch_datetime_format* + +You can do the same for the thread view: +> + let g:notmuch_datetime_format = '%d.%m.%y %H:%M:%S' +< + + *g:notmuch_folders_count_threads* + +If you want to count the threads instead of the messages in the folder view: +> + let g:notmuch_folders_count_threads = 0 +< + + *g:notmuch_reader* + *g:notmuch_sendmail* + +You can also configure your externail mail reader and sendemail program: +> + let g:notmuch_reader = 'mutt -f %s' + let g:notmuch_sendmail = 'sendmail' +< + +vim:tw=78:ts=8:noet:ft=help: diff --git a/vim/notmuch.yaml b/vim/notmuch.yaml index 6d368105..6f3b705c 100644 --- a/vim/notmuch.yaml +++ b/vim/notmuch.yaml @@ -2,6 +2,7 @@ addon: notmuch description: "notmuch mail user interface" files: - plugin/notmuch.vim + - doc/notmuch.txt - syntax/notmuch-compose.vim - syntax/notmuch-folders.vim - syntax/notmuch-git-diff.vim