News for release 0.38.3

[notmuch-wiki] / vimtips.mdwn

diff --git a/vimtips.mdwn b/vimtips.mdwn
index b531a77822b60ee0f9fbee97c149f7a858eff757..d77ed92d298b37b4b910ec2bfb8054b0556f915a 100644 (file)
--- a/vimtips.mdwn
+++ b/vimtips.mdwn
@@ -1,27 +1,46 @@
 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]

+# Tips and Tricks for using Notmuch with vim

 
 

-Notmuch is a great mail indexing tool that can also be used *in conjunction*
-with existing Mail User Agents (MUA) instead of replacing them. The advantage of
-such mixed solutions is that users can benefit from notmuch features (such as
-full-text search and thread reconstruction) without *having to* change MUA.
-
-A popular geek MUA is [the Mutt e-mail client](http://www.mutt.org); integrating
-notmuch with Mutt is not seamless, but fairly straightforward. There are two
-principal possibilities, either using a patched mutt that handles internally
-notmuch, or use a sets of scripts/handler within mutt to achieve something close.
+Tips for using Notmuch with vim; these may be applicable when using vim with
+[[notmuch-mutt]], [mutt-kz](https://github.com/karelzak/mutt-kz), or
+[notmuch-vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README).

 
 [[!toc levels=2]]
 
 
 [[!toc levels=2]]
 

+## Install the vim addon for Notmuch
+
+Before you can run Notmuch within vim, you must install notmuch as a vim addon.
+
+For example, if you have installed from the debian package:
+
+    $ sudo apt-get install notmuch-vim
+
+then to install as an addon, run this command:
+
+    $ vim-addon-manager install notmuch
+
+## Run Notmuch within vim
+
+Open vim and type
+
+    :Notmuch
+
+and press ENTER. Voila.
+
+
+Alternatively, you can invoke vim with the -c flag:
+
+    $ vim -c :Notmuch

 
 ## Addressbook management and vim
 
 
 ## Addressbook management and vim
 

-There are some emacs tips over [here](http://notmuchmail.org/emacstips/#index15h2) that
+There are some emacs tips over [[here|emacstips#index15h2]] that

 explains how to configure emacs with an addressbook, but the few solutions were not fast enough
 explains how to configure emacs with an addressbook, but the few solutions were not fast enough

-for me. And I never could test the vala-based code. So I updated the notmuch_addresses code to
+for me. And I never could test the vala-based code. So I updated the notmuch\_addresses code to

 use a cache to be able to make better matches and still be lightning fast.
 
 use a cache to be able to make better matches and still be lightning fast.
 

-And finally, [I needed](http://i.got.nothing.to/blog/2013/03/20/how-i-learned-to-stop-worrying-and-love-the-mail/) to have a way to autocomplete my recipients' addresses 
-automagically from within `vim`. So that's why I created the [notmuch_abook](https://github.com/guyzmo/notmuch-abook) code.
+And finally, [I needed](http://i.got.nothing.to/blog/2013/03/20/how-i-learned-to-stop-worrying-and-love-the-mail/) to have a way to autocomplete my recipients' addresses
+automagically from within `vim`. So that's why I created the [notmuch\_abook](https://github.com/guyzmo/notmuch-abook) code.

 You can either install it as a plugin in vim, using vundle:
 
         Vundle 'guyzmo/notmuch-abook'
 You can either install it as a plugin in vim, using vundle:
 
         Vundle 'guyzmo/notmuch-abook'


@@ -33,8 +52,8 @@ want to use it as standalone:
 
 To configure the address book, append to `~/.notmuch-config` the following:
 
 
 To configure the address book, append to `~/.notmuch-config` the following:
 

-        % cat > ~/.notmuch-config << EOF
-        
+        % cat >> ~/.notmuch-config << EOF
+

         [addressbook]
         path=/home/YOURUSERNAME/.notmuch-abook.db
         backend=sqlite3
         [addressbook]
         path=/home/YOURUSERNAME/.notmuch-abook.db
         backend=sqlite3


@@ -60,4 +79,3 @@ of each word in the name and address, as follows:
 
 If you're using vim, when you edit a mail having a filetype set to mail, you will be
 able to open a completion menu when you do <C-x><C-u> at every address header.
 
 If you're using vim, when you edit a mail having a filetype set to mail, you will be
 able to open a completion menu when you do <C-x><C-u> at every address header.

-