--- /dev/null
+Return-Path: <felipe.contreras@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 4A29C431FD9\r
+ for <notmuch@notmuchmail.org>; Sat, 2 Nov 2013 07:04:25 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.799\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
+ tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+ FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id yhOST8-RVZek for <notmuch@notmuchmail.org>;\r
+ Sat, 2 Nov 2013 07:04:19 -0700 (PDT)\r
+Received: from mail-ob0-f175.google.com (mail-ob0-f175.google.com\r
+ [209.85.214.175]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id 4921C429E52\r
+ for <notmuch@notmuchmail.org>; Sat, 2 Nov 2013 07:03:29 -0700 (PDT)\r
+Received: by mail-ob0-f175.google.com with SMTP id wm4so5575059obc.20\r
+ for <notmuch@notmuchmail.org>; Sat, 02 Nov 2013 07:03:28 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+ h=from:to:cc:subject:date:message-id:in-reply-to:references;\r
+ bh=4fLgBnjUY6TdOZNfGAOJ0qA0iqloO7Ql5v8adelfpgQ=;\r
+ b=NNVnnihsqNfWj6SGOsBsijbSYpFhcQlTt89BuBipE6K4lx+zHpxJSswge67w+KETGB\r
+ ZOzhyI5ccWzNXkVi7EHs2+B5FEGr7q90zKmUVt9hc2U+FXyTL9pH4QkvwItkz2FXP/fE\r
+ FJPATh+wxzFv//HkShaTIKapL+divHZO4qtR/3UOp9/82pXhpEzM0ZVYSV2aF5JfDshp\r
+ jqMOefB2c90lrzmMCgFABH5hJe96CBfe0KHHC4608srznHesq9WGSIulI7+bOgH5hZwg\r
+ vovXPemLkbQpdWVIG/FFjTSOu5QntSytuJcrp7rpHRwt4+BqIdFG0dlezRbAbzieP5XY\r
+ ieQg==\r
+X-Received: by 10.60.52.81 with SMTP id r17mr6561514oeo.3.1383401008838;\r
+ Sat, 02 Nov 2013 07:03:28 -0700 (PDT)\r
+Received: from localhost (187-162-140-241.static.axtel.net. [187.162.140.241])\r
+ by mx.google.com with ESMTPSA id\r
+ s9sm19945959obu.4.2013.11.02.07.03.27 for <multiple recipients>\r
+ (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+ Sat, 02 Nov 2013 07:03:28 -0700 (PDT)\r
+From: Felipe Contreras <felipe.contreras@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 21/21] vim: add help file\r
+Date: Sat, 2 Nov 2013 07:55:54 -0600\r
+Message-Id: <1383400554-1832-22-git-send-email-felipe.contreras@gmail.com>\r
+X-Mailer: git-send-email 1.8.4.2+fc1\r
+In-Reply-To: <1383400554-1832-1-git-send-email-felipe.contreras@gmail.com>\r
+References: <1383400554-1832-1-git-send-email-felipe.contreras@gmail.com>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 02 Nov 2013 14:04:25 -0000\r
+\r
+Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>\r
+---\r
+ debian/notmuch-vim.dirs | 1 +\r
+ debian/notmuch-vim.install | 1 +\r
+ vim/Makefile | 1 +\r
+ vim/notmuch.txt | 153 +++++++++++++++++++++++++++++++++++++++++++++\r
+ vim/notmuch.yaml | 1 +\r
+ 5 files changed, 157 insertions(+)\r
+ create mode 100644 vim/notmuch.txt\r
+\r
+diff --git a/debian/notmuch-vim.dirs b/debian/notmuch-vim.dirs\r
+index c978ac1..c6373e4 100644\r
+--- a/debian/notmuch-vim.dirs\r
++++ b/debian/notmuch-vim.dirs\r
+@@ -1,3 +1,4 @@\r
+ usr/share/vim/registry\r
+ usr/share/vim/addons/plugin\r
++usr/share/vim/addons/doc\r
+ usr/share/vim/addons/syntax\r
+diff --git a/debian/notmuch-vim.install b/debian/notmuch-vim.install\r
+index d444fef..a1af708 100644\r
+--- a/debian/notmuch-vim.install\r
++++ b/debian/notmuch-vim.install\r
+@@ -1,3 +1,4 @@\r
+ vim/notmuch.vim usr/share/vim/addons/plugin\r
++vim/notmuch.txt usr/share/vim/addons/doc\r
+ vim/syntax/notmuch-*.vim usr/share/vim/addons/syntax\r
+ vim/notmuch.yaml usr/share/vim/registry\r
+diff --git a/vim/Makefile b/vim/Makefile\r
+index bb3ec60..b6f9db7 100644\r
+--- a/vim/Makefile\r
++++ b/vim/Makefile\r
+@@ -8,6 +8,7 @@ all:\r
+ \r
+ install:\r
+ $(INSTALL) $(CURDIR)/notmuch.vim $(D)$(prefix)/plugin/notmuch.vim\r
++ $(INSTALL) $(CURDIR)/notmuch.txt $(D)$(prefix)/doc/notmuch.txt\r
+ @$(foreach file,$(wildcard syntax/*), \\r
+ $(INSTALL) $(CURDIR)/$(file) $(D)$(prefix)/$(file);)\r
+ \r
+diff --git a/vim/notmuch.txt b/vim/notmuch.txt\r
+new file mode 100644\r
+index 0000000..4374102\r
+--- /dev/null\r
++++ b/vim/notmuch.txt\r
+@@ -0,0 +1,153 @@\r
++*notmuch.txt* Plug-in to make vim a nice email client using notmuch\r
++\r
++Author: Felipe Contreras <felipe.contreras@gmail.com>\r
++\r
++Overview |notmuch-intro|\r
++Usage |notmuch-usage|\r
++Mappings |notmuch-mappings|\r
++Configuration |notmuch-config|\r
++\r
++==============================================================================\r
++OVERVIEW *notmuch-intro*\r
++\r
++This is a vim plug-in that provides a fully usable mail client interface,\r
++utilizing the notmuch framework.\r
++\r
++It has three main views: folders, search, and thread. In the folder view you\r
++can find a summary of saved searches, In the search view you can see all the\r
++threads that comprise the selected search, and in the thread view you can read\r
++every mail in the thread.\r
++\r
++==============================================================================\r
++USAGE *notmuch-usage*\r
++\r
++To use it, simply run the `:NotMuch` command.\r
++\r
++By default you start in the folder view which shows you default searches and\r
++the number of threads that match those:\r
++>\r
++ 10 new (tag:inbox and tag:unread)\r
++ 20 inbox (tag:inbox)\r
++ 30 unread (tag:unread)\r
++<\r
++You can see the threads of each by clicking `enter`, which sends you to the\r
++search view. In both the search and folder views you can type `s` to type a\r
++new search, or `=` to refresh. To see a thread, type `enter` again.\r
++\r
++To exit a view, click `q`.\r
++\r
++Also, you can specify a search directly:\r
++>\r
++ :NotMuch is:inbox and date:yesterday..\r
++<\r
++==============================================================================\r
++MAPPINGS *notmuch-mappings*\r
++\r
++------------------------------------------------------------------------------\r
++Folder view~\r
++\r
++<enter> Show selected search\r
++s Enter a new search\r
++= Refresh\r
++c Compose a new mail\r
++\r
++------------------------------------------------------------------------------\r
++Search view~\r
++\r
++q Quit view\r
++<enter> Show selected search\r
++<space> Show selected search with filter\r
++A Archive (-inbox -unread)\r
++I Mark as read (-unread)\r
++t Tag (prompted)\r
++s Search\r
++= Refresh\r
++? Show search information\r
++c Compose a new mail\r
++>\r
++------------------------------------------------------------------------------\r
++Thread view~\r
++\r
++q Quit view\r
++A Archive (-inbox -unread)\r
++I Mark as read (-unread)\r
++t Tag (prompted)\r
++s Search\r
++p Save patches\r
++r Reply\r
++? Show thread information\r
++<tab> Show next message\r
++c Compose a new mail\r
++\r
++------------------------------------------------------------------------------\r
++Compose view~\r
++\r
++q Quit view\r
++s Send\r
++\r
++==============================================================================\r
++CONFIGURATION *notmuch-config*\r
++\r
++You can add the following configurations to your `.vimrc`, or\r
++`~/.vim/plugin/notmuch.vim`.\r
++\r
++ *g:notmuch_folders*\r
++\r
++The first thing you might want to do is set your custom searches.\r
++>\r
++ let g:notmuch_folders = [\r
++ \ [ 'new', 'tag:inbox and tag:unread' ],\r
++ \ [ 'inbox', 'tag:inbox' ],\r
++ \ [ 'unread', 'tag:unread' ],\r
++ \ [ 'to-do', 'tag:to-do' ],\r
++ \ [ 'to-me', 'to:john.doe and tag:new' ],\r
++ \ ]\r
++<\r
++\r
++ *g:notmuch_custom_search_maps*\r
++ *g:notmuch_custom_show_maps*\r
++\r
++You can also configure the keyboard mappings for the different views:\r
++>\r
++ let g:notmuch_custom_search_maps = {\r
++ \ 't': 'search_tag("+to-do -inbox")',\r
++ \ 'd': 'search_tag("+deleted -inbox -unread")',\r
++ \ }\r
++\r
++ let g:notmuch_custom_show_maps = {\r
++ \ 't': 'show_tag("+to-do -inbox")',\r
++ \ 'd': 'show_tag("+deleted -inbox -unread")',\r
++ \ }\r
++<\r
++\r
++ *g:notmuch_date_format*\r
++\r
++To configure the date format you want in the search view:\r
++>\r
++ let g:notmuch_date_format = '%d.%m.%y'\r
++<\r
++\r
++ *g:notmuch_datetime_format*\r
++\r
++You can do the same for the thread view:\r
++>\r
++ let g:notmuch_datetime_format = '%d.%m.%y %H:%M:%S'\r
++<\r
++\r
++ *g:notmuch_folders_count_threads*\r
++\r
++If you want to count the threads instead of the messages in the folder view:\r
++>\r
++ let g:notmuch_folders_count_threads = 0\r
++<\r
++\r
++ *g:notmuch_reader*\r
++ *g:notmuch_sendmail*\r
++\r
++You can also configure your externail mail reader and sendemail program:\r
++>\r
++ let g:notmuch_reader = 'mutt -f %s'\r
++ let g:notmuch_sendmail = 'sendmail'\r
++<\r
++\r
++vim:tw=78:ts=8:noet:ft=help:\r
+diff --git a/vim/notmuch.yaml b/vim/notmuch.yaml\r
+index 6d36810..6f3b705 100644\r
+--- a/vim/notmuch.yaml\r
++++ b/vim/notmuch.yaml\r
+@@ -2,6 +2,7 @@ addon: notmuch\r
+ description: "notmuch mail user interface"\r
+ files:\r
+ - plugin/notmuch.vim\r
++ - doc/notmuch.txt\r
+ - syntax/notmuch-compose.vim\r
+ - syntax/notmuch-folders.vim\r
+ - syntax/notmuch-git-diff.vim\r
+-- \r
+1.8.4.2+fc1\r
+\r
projects / notmuch-archives.git / commitdiff