unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Mark Walters <markwalters1009@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH 2/3] contrib: add pick README.
Date: Sat, 27 Oct 2012 12:26:39 +0100	[thread overview]
Message-ID: <1351337200-18050-3-git-send-email-markwalters1009@gmail.com> (raw)
In-Reply-To: <1351337200-18050-1-git-send-email-markwalters1009@gmail.com>

---
 contrib/notmuch-pick/README |   38 ++++++++++++++++++++++++++++++++++++++
 1 files changed, 38 insertions(+), 0 deletions(-)
 create mode 100644 contrib/notmuch-pick/README

diff --git a/contrib/notmuch-pick/README b/contrib/notmuch-pick/README
new file mode 100644
index 0000000..6c27c53
--- /dev/null
+++ b/contrib/notmuch-pick/README
@@ -0,0 +1,38 @@
+NOTMUCH PICK
+
+Notmuch pick is an experimental threaded message view for the emacs
+interface. Each message is one line in the results and the thread
+structure is shown using UFT-8 box drawing characters (similar to
+Mutt's threaded view). It comes between search and show in terms of
+amount of output and can be useful for viewing both single theads and
+multiple threads.
+
+INSTALL
+
+Just copy the notmuch-pick.el file somewhere into emacs's load-path.
+
+Then after the "(require 'notmuch)" line in your .emacs file add
+the line "(require 'notmuch-pick nil t)". This will load notmuch-pick on
+your next emacs start.
+
+USING PICK
+
+The main key entries to notmuch pick are
+
+'z' enter a query to view using notmuch pick (works in hello, search,
+    show and pick itself).
+'Z' view the current query in pick (works from search and show)
+'M-RET' view the selected thread in pick (works in search mode)
+
+Once in pick mode keybinding are mostly inline with the rest of
+notmuch and are all viewable with '?' as usual.
+
+CUSTOMISING PICK
+
+Pick has several customisation variables. The most significant is the
+first notmuch-pick-show-out which determines the behaviour when
+selecting a message (with RET) in the pick view. By default pick uses
+a split window showing the single message in the bottom pane. However,
+if this option is set then it views the whole thread in the complete
+window jumping to the selected message in the thread. In either case
+M-RET selects the other option.
-- 
1.7.9.1

  parent reply	other threads:[~2012-10-27 11:26 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-10-27 11:26 [PATCH 0/3] Add notmuch-pick to contrib Mark Walters
2012-10-27 11:26 ` [PATCH 1/3] contrib: add notmuch-pick.el file itself Mark Walters
2012-10-27 17:39   ` Ethan Glasser-Camp
2012-10-27 17:49     ` Mark Walters
2012-10-27 11:26 ` Mark Walters [this message]
2012-10-27 12:55   ` [PATCH 2/3] contrib: add pick README Eirik Byrkjeflot Anonsen
2012-10-27 13:38   ` [PATCH v2] " Mark Walters
2012-10-27 11:26 ` [PATCH 3/3] contrib: add pick TODO file Mark Walters
2012-10-27 12:13 ` [PATCH 0/3] Add notmuch-pick to contrib Tomi Ollila
2012-10-28 15:16 ` David Bremner
2012-10-29  8:28   ` Mark Walters
2012-12-01 21:03   ` Mark Walters

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=1351337200-18050-3-git-send-email-markwalters1009@gmail.com \
    --to=markwalters1009@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).