]> git.cworth.org Git - notmuch-wiki/commitdiff
notmuch-emacs: clean up the setup process description
authorJani Nikula <jani@nikula.org>
Wed, 2 Mar 2016 09:10:04 +0000 (11:10 +0200)
committerJani Nikula <jani@nikula.org>
Wed, 2 Mar 2016 09:10:04 +0000 (11:10 +0200)
notmuch-emacs.mdwn

index 0d89435158d044707367d7e680820fcfe7e2ff42..9391f4ea09e3eb2b83456b6ee4eaaa38e25c50c3 100644 (file)
@@ -11,13 +11,31 @@ 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
 
-### <span id="notmuch_init_file"> Notmuch Emacs configuration file: </span>
+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)
+### <span id="notmuch_init_file"> Notmuch Emacs configuration file </span>
 
 After Notmuch is loaded `notmuch-init-file` (typically
  `~/.emacs.d/notmuch-config.el`) is checked out. If such file exists