From: Felipe Contreras <felipe.contreras@gmail.com>
To: notmuch@notmuchmail.org
Cc: Felipe Contreras <felipe.contreras@gmail.com>
Subject: [PATCH 13/13] vim: README: sync with upstream
Date: Sun, 18 Apr 2021 17:48:51 -0500 [thread overview]
Message-ID: <20210418224851.88240-14-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210418224851.88240-1-felipe.contreras@gmail.com>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
vim/README | 27 +++++++++++++++++----------
1 file changed, 17 insertions(+), 10 deletions(-)
diff --git a/vim/README b/vim/README
index c137bacd..d9a635a2 100644
--- a/vim/README
+++ b/vim/README
@@ -3,7 +3,7 @@
This is a vim plug-in that provides a fully usable mail client interface,
utilizing the notmuch framework, through it's ruby bindings.
-== install ==
+== Install ==
Simply run 'make install'. However, check that you have the dependencies below.
@@ -12,6 +12,8 @@ Simply run 'make install'. However, check that you have the dependencies below.
Make sure your vim version has ruby support: check for +ruby in 'vim --version'
features.
+ % vim --version | grep +ruby
+
=== ruby bindings ===
Check if you are able to run the following command cleanly:
@@ -28,16 +30,10 @@ directory in the notmuch source tree.
Since libnotmuch library concentrates on things other than handling mail, we
need a library to do that, and for Ruby the best library for that is called
-'mail'. The easiest way to install it is with ruby's gem. In most distro's the
-package is called 'rubygems'.
-
-Once you have gem, run:
+'mail':
% gem install mail
-In some systems gems are installed on a per-user basis by default, so make sure
-you are running as the same user as the one that installed them.
-
This gem is not mandatory, but it's extremely recommended.
== Running ==
@@ -46,6 +42,15 @@ Simple:
% gvim -c ':NotMuch'
+You might want to write a wrapper script (e.g. `vnm`)
+
+ #!/bin/sh
+ gvim -c ":NotMuch $*"
+
+So you can run:
+
+ vnm is:inbox date:yesterday..
+
Enjoy ;)
== More stuff ==
@@ -53,10 +58,12 @@ Enjoy ;)
As an example to configure a key mapping to add the tag 'to-do' and archive,
this is what I use:
-let g:notmuch_rb_custom_search_maps = {
+----
+let g:notmuch_custom_search_maps = {
\ 't': 'search_tag("+to-do -inbox")',
\ }
-let g:notmuch_rb_custom_show_maps = {
+let g:notmuch_custom_show_maps = {
\ 't': 'show_tag("+to-do -inbox")',
\ }
+----
--
2.31.0
next prev parent reply other threads:[~2021-04-18 22:50 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-18 22:48 [PATCH 00/13] vim: a bunch of updates from upstream Felipe Contreras
2021-04-18 22:48 ` [PATCH 01/13] vim: fix Mail 2.8.0 warning Felipe Contreras
2021-04-26 23:10 ` David Bremner
2021-04-18 22:48 ` [PATCH 02/13] vim: doc: small fixes Felipe Contreras
2021-04-18 22:48 ` [PATCH 03/13] vim: doc: minor spelling fix Felipe Contreras
2021-04-18 22:48 ` [PATCH 04/13] vim: fix for missing parts Felipe Contreras
2021-04-18 22:48 ` [PATCH 05/13] vim: show first part if no text part is detected Felipe Contreras
2021-04-18 22:48 ` [PATCH 06/13] vim: trivial cleanup Felipe Contreras
2021-04-18 22:48 ` [PATCH 07/13] vim: use notmuch config command Felipe Contreras
2021-04-18 22:48 ` [PATCH 08/13] vim: trivial cleanup Felipe Contreras
2021-04-18 22:48 ` [PATCH 09/13] vim: option to add email address to reply quote Felipe Contreras
2021-04-18 22:48 ` [PATCH 10/13] vim: option to add reply quote datetime Felipe Contreras
2021-04-18 22:48 ` [PATCH 11/13] vim: syntax: fix message description highlighting Felipe Contreras
2021-04-18 22:48 ` [PATCH 12/13] vim: remove backwards compatibility wrappers Felipe Contreras
2021-04-18 22:48 ` Felipe Contreras [this message]
2021-04-19 10:16 ` [PATCH 00/13] vim: a bunch of updates from upstream David Bremner
2021-04-19 20:44 ` Felipe Contreras
2021-04-19 22:14 ` David Bremner
2021-04-20 3:21 ` Felipe Contreras
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210418224851.88240-14-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).