diff options
author | Anton Khirnov <anton@khirnov.net> | 2012-08-06 18:10:31 +0200 |
---|---|---|
committer | Anton Khirnov <anton@khirnov.net> | 2012-08-06 18:10:31 +0200 |
commit | 7192d0221a361d3d9cfd6626058e4a1c86ea7b44 (patch) | |
tree | 11d3db0604f47498e16b50ef7f559e138bfe4482 /contrib/notmuch-mutt/README | |
parent | 6bc2f5a999d9ff77779d98b7cc688a4350ea65d9 (diff) | |
parent | 6b820673fc9c2483572af5ec7ea91e4d7d7258c9 (diff) |
Merge remote-tracking branch 'origin/master' into vim
Diffstat (limited to 'contrib/notmuch-mutt/README')
-rw-r--r-- | contrib/notmuch-mutt/README | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/contrib/notmuch-mutt/README b/contrib/notmuch-mutt/README new file mode 100644 index 0000000..382ac91 --- /dev/null +++ b/contrib/notmuch-mutt/README @@ -0,0 +1,59 @@ +notmuch-mutt: Notmuch (of a) helper for Mutt +============================================ + +notmuch-mutt provide integration among the [Mutt] [1] mail user agent and the +[Notmuch] [2] mail indexer. + +notmuch-mutt offer two main integration features. The first one is the ability +of stating a **search query interactively** and then jump to a fresh Maildir +containing its search results only. The second one is the ability to +**reconstruct threads on the fly** starting from the currently highlighted +mail, which comes handy when a thread has been split across different maildirs, +archived, or the like. + +notmuch-mutt enables to trigger mail searches via a Mutt macro (usually F8) and +reconstruct threads via another (usually F9). Check the manpage for the 2-liner +configuration snippet for your Mutt configuration files (~/.muttrc, +/etc/Muttrc, or a /etc/Muttrc.d snippet). + +A [blog style introduction] [3] to notmuch-mutt is available and includes some +more rationale for its existence. + +Arguably, some of the logics of notmuch-mutt could disappear by adding support +for a --output=symlinks flag to notmuch. + + +[1]: http://www.mutt.org/ +[2]: http://notmuchmail.org/ +[3]: http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/ + + +Requirements +------------ + +To *run* notmuch-mutt you will need Perl with the following libraries: + +- Mail::Box <http://search.cpan.org/~markov/Mail-Box/> + (Debian package: libmail-box-perl) +- Mail::Internet <http://search.cpan.org/~markov/MailTools/> + (Debian package: libmailtools-perl) +- String::ShellQuote <http://search.cpan.org/~rosch/String-ShellQuote/ShellQuote.pm> + (Debian package: libstring-shellquote-perl) +- Term::ReadLine <http://search.cpan.org/~hayashi/Term-ReadLine-Gnu/> + (Debian package: libterm-readline-gnu-perl) + +To *build* notmuch-mutt documentation you will need: + +- pod2man (coming with Perl) to generate the manpage +- markdown to generate README.html out of this file + + +License +------- + +notmuch-mutt is copyright (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>. + +notmuch-mutt is released under the terms of the GNU General Public License +(GPL), version 3 or above. A copy of the license is available online at +<http://www.gnu.org/licenses/>. + |