[PATCH 21/21] vim: add help file
Felipe Contreras writes: > > You can probably check that it's working with this: > % vim -c ":h notmuch" It turns I needed to re-run "vim-addon-manager install notmuch" This might be a bit debian specific, but it's already documented as needed for the initial install. It would probably be worth updating debian/notmuch-vim.README.Debian to suggest running this on upgrade as well. Otherwise running :helptags wants write into /usr/share/vim/addons/doc, which is naturally a bit tricky for a non-root user.
[PATCH 21/21] vim: add help file
On Fri, Nov 8, 2013 at 12:03 PM, David Bremner wrote: > Felipe Contreras writes: >> >> You can probably check that it's working with this: >> % vim -c ":h notmuch" > > It turns I needed to re-run > >"vim-addon-manager install notmuch" > > This might be a bit debian specific, but it's already documented as > needed for the initial install. It would probably be worth updating > debian/notmuch-vim.README.Debian to suggest running this on upgrade as > well. Shouldn't this happen on a post update script or something? -- Felipe Contreras
[PATCH 21/21] vim: add help file
Felipe Contreras writes: > Signed-off-by: Felipe Contreras > --- > debian/notmuch-vim.dirs| 1 + > debian/notmuch-vim.install | 1 + > vim/Makefile | 1 + > vim/notmuch.txt| 153 > + > vim/notmuch.yaml | 1 + I verified that these changes don't break the debian build. FWIW, I didn't manage to invoke the notmuch help within vim, but that's probably just invimcompetence on my part. Let me know if there is something you'd like me to verify on the debian packages. d
[PATCH 21/21] vim: add help file
On Fri, Nov 8, 2013 at 6:43 AM, David Bremner wrote: > Felipe Contreras writes: > >> Signed-off-by: Felipe Contreras >> --- >> debian/notmuch-vim.dirs| 1 + >> debian/notmuch-vim.install | 1 + >> vim/Makefile | 1 + >> vim/notmuch.txt| 153 >> + >> vim/notmuch.yaml | 1 + > > I verified that these changes don't break the debian build. FWIW, I > didn't manage to invoke the notmuch help within vim, but that's probably > just invimcompetence on my part. Let me know if there is something > you'd like me to verify on the debian packages. You can probably check that it's working with this: % vim -c ":h notmuch" If that doesn't work, you might need to do this first: % vim -c ':helptags /usr/share/vim/addons/doc' -c q -- Felipe Contreras
Re: [PATCH 21/21] vim: add help file
Felipe Contreras felipe.contre...@gmail.com writes: Signed-off-by: Felipe Contreras felipe.contre...@gmail.com --- debian/notmuch-vim.dirs| 1 + debian/notmuch-vim.install | 1 + vim/Makefile | 1 + vim/notmuch.txt| 153 + vim/notmuch.yaml | 1 + I verified that these changes don't break the debian build. FWIW, I didn't manage to invoke the notmuch help within vim, but that's probably just invimcompetence on my part. Let me know if there is something you'd like me to verify on the debian packages. d ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH 21/21] vim: add help file
On Fri, Nov 8, 2013 at 6:43 AM, David Bremner da...@tethera.net wrote: Felipe Contreras felipe.contre...@gmail.com writes: Signed-off-by: Felipe Contreras felipe.contre...@gmail.com --- debian/notmuch-vim.dirs| 1 + debian/notmuch-vim.install | 1 + vim/Makefile | 1 + vim/notmuch.txt| 153 + vim/notmuch.yaml | 1 + I verified that these changes don't break the debian build. FWIW, I didn't manage to invoke the notmuch help within vim, but that's probably just invimcompetence on my part. Let me know if there is something you'd like me to verify on the debian packages. You can probably check that it's working with this: % vim -c :h notmuch If that doesn't work, you might need to do this first: % vim -c ':helptags /usr/share/vim/addons/doc' -c q -- Felipe Contreras ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH 21/21] vim: add help file
Felipe Contreras felipe.contre...@gmail.com writes: You can probably check that it's working with this: % vim -c :h notmuch It turns I needed to re-run vim-addon-manager install notmuch This might be a bit debian specific, but it's already documented as needed for the initial install. It would probably be worth updating debian/notmuch-vim.README.Debian to suggest running this on upgrade as well. Otherwise running :helptags wants write into /usr/share/vim/addons/doc, which is naturally a bit tricky for a non-root user. ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH 21/21] vim: add help file
On Fri, Nov 8, 2013 at 12:03 PM, David Bremner da...@tethera.net wrote: Felipe Contreras felipe.contre...@gmail.com writes: You can probably check that it's working with this: % vim -c :h notmuch It turns I needed to re-run vim-addon-manager install notmuch This might be a bit debian specific, but it's already documented as needed for the initial install. It would probably be worth updating debian/notmuch-vim.README.Debian to suggest running this on upgrade as well. Shouldn't this happen on a post update script or something? -- Felipe Contreras ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH 21/21] vim: add help file
Felipe Contreras felipe.contre...@gmail.com writes: On Fri, Nov 8, 2013 at 12:03 PM, David Bremner da...@tethera.net wrote: This might be a bit debian specific, but it's already documented as needed for the initial install. It would probably be worth updating debian/notmuch-vim.README.Debian to suggest running this on upgrade as well. Shouldn't this happen on a post update script or something? Yeah, I talked to the Debian vim maintainer, and apparently that is a design flaw with the current way vim addons are managed. So the best we can do for the moment is put a note in debian/notmuch-vim.NEWS (in the same format as debian/NEWS.Debian. The format is a bit fussy, so I can take care of that. d ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH 21/21] vim: add help file
Signed-off-by: Felipe Contreras --- debian/notmuch-vim.dirs| 1 + debian/notmuch-vim.install | 1 + vim/Makefile | 1 + vim/notmuch.txt| 153 + vim/notmuch.yaml | 1 + 5 files changed, 157 insertions(+) create mode 100644 vim/notmuch.txt diff --git a/debian/notmuch-vim.dirs b/debian/notmuch-vim.dirs index c978ac1..c6373e4 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 d444fef..a1af708 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 bb3ec60..b6f9db7 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 000..4374102 --- /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',
[PATCH 21/21] vim: add help file
Signed-off-by: Felipe Contreras felipe.contre...@gmail.com --- debian/notmuch-vim.dirs| 1 + debian/notmuch-vim.install | 1 + vim/Makefile | 1 + vim/notmuch.txt| 153 + vim/notmuch.yaml | 1 + 5 files changed, 157 insertions(+) create mode 100644 vim/notmuch.txt diff --git a/debian/notmuch-vim.dirs b/debian/notmuch-vim.dirs index c978ac1..c6373e4 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 d444fef..a1af708 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 bb3ec60..b6f9db7 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 000..4374102 --- /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 felipe.contre...@gmail.com + +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~ + +enterShow selected search +s Enter a new search += Refresh +c Compose a new mail + +-- +Search view~ + +q Quit view +enterShow selected search +spaceShow 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 +tab 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' ], +
