About this Manual
=================
-This manual covers only the emacs interface to notmuch. For information
-on the command line interface, see See section “Description” in Notmuch
-Manual Pager. To save typing, we will sometimes use *notmuch* in this
-manual to refer to the Emacs interface to notmuch. If the distinction
-should every be important, we’ll refer to the Emacs inteface as
+This manual covers only the Emacs interface to Notmuch. For information
+on the command line interface, see section “Description” in the Notmuch
+Manual Pages. To save typing, we will sometimes use *notmuch* in this
+manual to refer to the Emacs interface to Notmuch. When this distinction
+is important, we’ll refer to the Emacs interface as
*notmuch-emacs*.
Notmuch-emacs is highly customizable via the the Emacs customization
framework (or just by setting the appropriate variables). We try to
point out relevant variables in this manual, but in order to avoid
-duplication of information, but you can usually find the most detailed
-description in the varables docstring.
+duplication of information, you can usually find the most detailed
+description in the variables' docstring.
notmuch-hello
=============
single: notmuch-hello
single: notmuch
-``notmuch-hello`` is the main entry point for notmuch. You can start it
+``notmuch-hello`` is the main entry point for Notmuch. You can start it
with ``M-x notmuch`` or ``M-x notmuch-hello``. The startup screen looks
something like the following. There are some hints at the bottom of the
screen. There are three main parts to the notmuch-hello screen,
| ``=`` to refresh this screen. ``s`` to search messages. ``q`` to quit.
| **Customize** this page.
-You can change the overall appearence of the notmuch-hello screen by
+You can change the overall appearance of the notmuch-hello screen by
customizing the variable :index:`notmuch-hello-sections`.
``<tab>``
Move to the next widget (button or text entry field)
-``<backtab>``
+``<backspace>``
Move to the previous widget.
``<return>``
Saved Searches
--------------
-Notmuch replaces the static assignment of messages with the more dynamic
-notion of searching. Notmuch-hello presents the user with a customizable
-set of saved searchs. The initial defaults are ``tag:inbox`` and
-``tag:unread``, but you can customize the following variables
+Since notmuch is entirely search-based, it's often useful to organize
+mail around common searches. To facilitate this, the first section of
+notmuch-hello presents a customizable set of saved searches. Saved
+searches can also be accessed from anywhere in notmuch by pressing
+``j`` to access :ref:`notmuch-jump`.
+
+The saved searches default to various common searches such as
+``tag:inbox`` to access the inbox and ``tag:unread`` to access all
+unread mail, but there are several options for customization:
:index:`notmuch-saved-searches`
- A list of cons pairs, the first being the name to display, the
- second being a query string for notmuch. See section “Description”
- in Notmuch Query Syntax.
+ The list of saved searches, including names, queries, and
+ additional per-query options.
:index:`notmuch-saved-searches-sort-function`
This variable controls how saved searches should be sorted. A value
Search Box
----------
-The search box lets the user enter an notmuch query. See section
-“Description” in Notmuch Query Syntax, for more info on notmuch query
+The search box lets the user enter a Notmuch query. See section
+“Description” in Notmuch Query Syntax, for more info on Notmuch query
syntax. A history of recent searches is also displayed by default. The
latter is controlled by the variable :index:`notmuch-hello-recent-searches-max`.
notmuch-tree
============
+Global key bindings
+===================
+
+Several features are accessible from anywhere in notmuch through the
+following key bindings:
+
+``j``
+ Jump to saved searches using :ref:`notmuch-jump`.
+
+notmuch-jump
+------------
+
+Saved searches configured through :ref:`notmuch-saved-searches` can
+include a "shortcut key" that's accessible through notmuch-jump.
+Pressing ``j`` anywhere in notmuch followed by the configured shortcut
+key of a saved search will immediately jump to that saved search. For
+example, in the default configuration ``j i`` jumps immediately to the
+inbox search. When you press ``j``, notmuch-jump shows the saved
+searches and their shortcut keys in the mini-buffer.
+
Configuration
=============
:index:`notmuch-poll`
:index:`notmuch-poll-script`
+
+Init File
+---------
+
+When Notmuch is loaded, it will read the ``notmuch-init-file``
+(``~/.emacs.d/notmuch-config`` by default) file. This is normal Emacs Lisp
+file and can be used to avoid cluttering your ``~/.emacs`` with Notmuch
+stuff. If the file with ``.elc``, ``.elc.gz``, ``.el`` or ``.el.gz``
+suffix exist it will be read instead (just one of these, chosen in this
+order). Most often users create ``~/.emacs.d/notmuch-config.el`` and just
+work with it. If Emacs was invoked with the ``-q`` or ``--no-init-file``
+options, ``notmuch-init-file`` is not read.
projects / notmuch / blobdiff