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 USING PICK
  19
  20 The main key entries to notmuch pick are
  21
  22 'z' enter a query to view using notmuch pick (works in hello, search,
  23     show and pick itself).
  24 'Z' view the current query in pick (works from search and show)
  25 'M-RET' view the selected thread in pick (works in search mode)
  26
  27 Once in pick mode, keybindings are mostly in line with the rest of
  28 notmuch and are all viewable with '?' as usual.
  29
  30 CUSTOMISING PICK
  31
  32 Pick has several customisation variables. The most significant is the
  33 first notmuch-pick-show-out which determines the behaviour when
  34 selecting a message (with RET) in the pick view. By default pick uses
  35 a split window showing the single message in the bottom pane. However,
  36 if this option is set then it views the whole thread in the complete
  37 window jumping to the selected message in the thread. In either case
  38 M-RET selects the other option.