unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob d9a635a2f69fa6db7bb87b7432acf483d9fb4bc6 1455 bytes (raw)
name: vim/README 	 # note: path name is non-authoritative(*)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
== notmuch vim ruby ==

This is a vim plug-in that provides a fully usable mail client interface,
utilizing the notmuch framework, through it's ruby bindings.

== Install ==

Simply run 'make install'. However, check that you have the dependencies below.

=== vim +ruby ===

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:

 % ruby -e "require 'notmuch'"

If you don't see any errors, it means it's working and you can go to the next
section.

If it's not, you would need to compile them. Go to the 'bindings/ruby'
directory in the notmuch source tree.

=== mail gem ===

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':

 % gem install mail

This gem is not mandatory, but it's extremely recommended.

== Running ==

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 ==

As an example to configure a key mapping to add the tag 'to-do' and archive,
this is what I use:

----
let g:notmuch_custom_search_maps = {
	\ 't':		'search_tag("+to-do -inbox")',
	\ }

let g:notmuch_custom_show_maps = {
	\ 't':		'show_tag("+to-do -inbox")',
	\ }
----

debug log:

solving d9a635a2 ...
found d9a635a2 in https://yhetil.org/notmuch/20210418224851.88240-14-felipe.contreras@gmail.com/
found c137bacd in https://yhetil.org/notmuch.git/
preparing index
index prepared:
100644 c137bacdc0f4f1e3af78cb9617d5fe92f527c53f	vim/README

applying [1/1] https://yhetil.org/notmuch/20210418224851.88240-14-felipe.contreras@gmail.com/
diff --git a/vim/README b/vim/README
index c137bacd..d9a635a2 100644

Checking patch vim/README...
Applied patch vim/README cleanly.

index at:
100644 d9a635a2f69fa6db7bb87b7432acf483d9fb4bc6	vim/README

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

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).