X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=notmuch-emacs.mdwn;h=9391f4ea09e3eb2b83456b6ee4eaaa38e25c50c3;hb=6af7f7dbf56bba07b8e3dcd567f51230c230b8d4;hp=2e09dd27ffc2c1a748219c7b3509fa0ecf5127e8;hpb=30366b953dd3bf6c402ad4d6be1fa09360efa92a;p=notmuch-wiki diff --git a/notmuch-emacs.mdwn b/notmuch-emacs.mdwn index 2e09dd2..9391f4e 100644 --- a/notmuch-emacs.mdwn +++ b/notmuch-emacs.mdwn @@ -4,20 +4,38 @@ One of the more popular Notmuch message reading clients is **notmuch.el**, or `notmuch-emacs`, an [Emacs](http://www.gnu.org/software/emacs/) major mode for interacting with Notmuch. It is included in the Notmuch package (`notmuch-emacs` -in Debian). +in Debian). The [[screenshots|screenshots]] give a good overview of the mode. This page is a basic guide for setting up and using Notmuch with Emacs. See also the [[tips and tricks page|emacstips]] for more advanced details. [[!toc levels=2]] -## Setup +## Prerequisites + +The Notmuch Emacs interface uses the Notmuch [[command line interface|manpages]] +to interact with the Notmuch database and your mail store. Please make sure +you've [[set up Notmuch|getting-started]] first. + +## Installation + +Due to the dependency on the command line interface, the Notmuch Emacs interface +version must be compatible with the Notmuch version. On Linux, the easiest way +to ensure this is to use the package(s) in your distribution's package +repository. -Have a look at the [[Howto|howto]] for prerequisites. Be sure you have done the -general setup using the Notmuch cli command! +If you've installed Notmuch from a [git +checkout](http://git.notmuchmail.org/git/notmuch) or a [source +release](http://notmuchmail.org/releases/), Notmuch Emacs is included by +default. -To use the Notmuch Emacs mode, first add the following line to your `.emacs` rc -file: +It is **not** recommended to install Notmuch Emacs from the Emacs Lisp Package +Archive (ELPA), as the version there is likely not in sync with the command line +interface. + +## Setup + +First, you need to tell Emacs about Notmuch. Add this to your `.emacs` rc file: (autoload 'notmuch "notmuch" "notmuch mail" t) @@ -25,12 +43,17 @@ or if you always want to load Notmuch when you start Emacs: (require 'notmuch) -Then, either run `emacs -f notmuch`, or execute the command `M-x notmuch` from -within a running Emacs. +To start Notmuch Emacs, either run `emacs -f notmuch`, or execute the command +`M-x notmuch RET` from within a running Emacs. This will bring you to the +Notmuch Hello view. + +## Customization -### Notmuch Emacs configuration file: +Notmuch Emacs uses the Emacs customization interface extensively for +configuration. Execute `M-x customize-group RET notmuch RET` to get to the +Notmuch main customization group. -(Since Notmuch 0.18) +### Notmuch Emacs configuration file After Notmuch is loaded `notmuch-init-file` (typically `~/.emacs.d/notmuch-config.el`) is checked out. If such file exists