From cb39739897fec20d230c46954839ffc60abdd7a4 Mon Sep 17 00:00:00 2001 From: Felipe Contreras Date: Sun, 3 Nov 2013 07:55:54 +1800 Subject: [PATCH] [PATCH 21/21] vim: add help file --- 1c/d5046cb13f5cd422973fd150fe04e45aa0d73b | 276 ++++++++++++++++++++++ 1 file changed, 276 insertions(+) create mode 100644 1c/d5046cb13f5cd422973fd150fe04e45aa0d73b diff --git a/1c/d5046cb13f5cd422973fd150fe04e45aa0d73b b/1c/d5046cb13f5cd422973fd150fe04e45aa0d73b new file mode 100644 index 000000000..203bd930d --- /dev/null +++ b/1c/d5046cb13f5cd422973fd150fe04e45aa0d73b @@ -0,0 +1,276 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 4A29C431FD9 + for ; Sat, 2 Nov 2013 07:04:25 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.799 +X-Spam-Level: +X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id yhOST8-RVZek for ; + Sat, 2 Nov 2013 07:04:19 -0700 (PDT) +Received: from mail-ob0-f175.google.com (mail-ob0-f175.google.com + [209.85.214.175]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 4921C429E52 + for ; Sat, 2 Nov 2013 07:03:29 -0700 (PDT) +Received: by mail-ob0-f175.google.com with SMTP id wm4so5575059obc.20 + for ; Sat, 02 Nov 2013 07:03:28 -0700 (PDT) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:in-reply-to:references; + bh=4fLgBnjUY6TdOZNfGAOJ0qA0iqloO7Ql5v8adelfpgQ=; + b=NNVnnihsqNfWj6SGOsBsijbSYpFhcQlTt89BuBipE6K4lx+zHpxJSswge67w+KETGB + ZOzhyI5ccWzNXkVi7EHs2+B5FEGr7q90zKmUVt9hc2U+FXyTL9pH4QkvwItkz2FXP/fE + FJPATh+wxzFv//HkShaTIKapL+divHZO4qtR/3UOp9/82pXhpEzM0ZVYSV2aF5JfDshp + jqMOefB2c90lrzmMCgFABH5hJe96CBfe0KHHC4608srznHesq9WGSIulI7+bOgH5hZwg + vovXPemLkbQpdWVIG/FFjTSOu5QntSytuJcrp7rpHRwt4+BqIdFG0dlezRbAbzieP5XY + ieQg== +X-Received: by 10.60.52.81 with SMTP id r17mr6561514oeo.3.1383401008838; + Sat, 02 Nov 2013 07:03:28 -0700 (PDT) +Received: from localhost (187-162-140-241.static.axtel.net. [187.162.140.241]) + by mx.google.com with ESMTPSA id + s9sm19945959obu.4.2013.11.02.07.03.27 for + (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); + Sat, 02 Nov 2013 07:03:28 -0700 (PDT) +From: Felipe Contreras +To: notmuch@notmuchmail.org +Subject: [PATCH 21/21] vim: add help file +Date: Sat, 2 Nov 2013 07:55:54 -0600 +Message-Id: <1383400554-1832-22-git-send-email-felipe.contreras@gmail.com> +X-Mailer: git-send-email 1.8.4.2+fc1 +In-Reply-To: <1383400554-1832-1-git-send-email-felipe.contreras@gmail.com> +References: <1383400554-1832-1-git-send-email-felipe.contreras@gmail.com> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 02 Nov 2013 14:04:25 -0000 + +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 0000000..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', 'tag:to-do' ], ++ \ [ 'to-me', 'to:john.doe and tag:new' ], ++ \ ] ++< ++ ++ *g:notmuch_custom_search_maps* ++ *g:notmuch_custom_show_maps* ++ ++You can also configure the keyboard mappings for the different views: ++> ++ let g:notmuch_custom_search_maps = { ++ \ 't': 'search_tag("+to-do -inbox")', ++ \ 'd': 'search_tag("+deleted -inbox -unread")', ++ \ } ++ ++ let g:notmuch_custom_show_maps = { ++ \ 't': 'show_tag("+to-do -inbox")', ++ \ 'd': 'show_tag("+deleted -inbox -unread")', ++ \ } ++< ++ ++ *g:notmuch_date_format* ++ ++To configure the date format you want in the search view: ++> ++ let g:notmuch_date_format = '%d.%m.%y' ++< ++ ++ *g:notmuch_datetime_format* ++ ++You can do the same for the thread view: ++> ++ let g:notmuch_datetime_format = '%d.%m.%y %H:%M:%S' ++< ++ ++ *g:notmuch_folders_count_threads* ++ ++If you want to count the threads instead of the messages in the folder view: ++> ++ let g:notmuch_folders_count_threads = 0 ++< ++ ++ *g:notmuch_reader* ++ *g:notmuch_sendmail* ++ ++You can also configure your externail mail reader and sendemail program: ++> ++ let g:notmuch_reader = 'mutt -f %s' ++ let g:notmuch_sendmail = 'sendmail' ++< ++ ++vim:tw=78:ts=8:noet:ft=help: +diff --git a/vim/notmuch.yaml b/vim/notmuch.yaml +index 6d36810..6f3b705 100644 +--- a/vim/notmuch.yaml ++++ b/vim/notmuch.yaml +@@ -2,6 +2,7 @@ addon: notmuch + description: "notmuch mail user interface" + files: + - plugin/notmuch.vim ++ - doc/notmuch.txt + - syntax/notmuch-compose.vim + - syntax/notmuch-folders.vim + - syntax/notmuch-git-diff.vim +-- +1.8.4.2+fc1 + -- 2.26.2