From 04c4085ab35d4636017af60ce9d8f936dbd85e90 Mon Sep 17 00:00:00 2001 From: Mark Walters Date: Sat, 27 Oct 2012 14:38:26 +0100 Subject: [PATCH] contrib: add pick README. --- contrib/notmuch-pick/README | 38 +++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 contrib/notmuch-pick/README diff --git a/contrib/notmuch-pick/README b/contrib/notmuch-pick/README new file mode 100644 index 00000000..8eed974e --- /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 UTF-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 threads 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, keybindings are mostly in line 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.