git.notmuchmail.org Git - notmuch/blob - contrib/notmuch-pick/README

   1 NOTMUCH PICK
   2
   3 Notmuch pick is an experimental threaded message view for the emacs
   4 interface. Each message is one line in the results and the thread
   5 structure is shown using UTF-8 box drawing characters (similar to
   6 Mutt's threaded view). It comes between search and show in terms of
   7 amount of output and can be useful for viewing both single threads and
   8 multiple threads.
   9
  10 INSTALL
  11
  12 Just copy the notmuch-pick.el file somewhere into emacs's load-path.
  13
  14 Then after the "(require 'notmuch)" line in your .emacs file add
  15 the line "(require 'notmuch-pick nil t)". This will load notmuch-pick on
  16 your next emacs start.
  17
  18 TEST
  19
  20 Just execute run-tests.sh and it should all work (it does require that
  21 notmuch has already been built).
  22
  23 USING PICK
  24
  25 The main key entries to notmuch pick are
  26
  27 'z' enter a query to view using notmuch pick (works in hello, search,
  28     show and pick itself).
  29 'Z' view the current query in pick (works from search and show)
  30 'M-RET' view the selected thread in pick (works in search mode)
  31
  32 Once in pick mode, keybindings are mostly in line with the rest of
  33 notmuch and are all viewable with '?' as usual.
  34
  35 CUSTOMISING PICK
  36
  37 Pick has several customisation variables. The most significant is the
  38 first notmuch-pick-show-out which determines the behaviour when
  39 selecting a message (with RET) in the pick view. By default pick uses
  40 a split window showing the single message in the bottom pane. However,
  41 if this option is set then it views the whole thread in the complete
  42 window jumping to the selected message in the thread. In either case
  43 M-RET selects the other option.