=================
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 interface as
+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 variables docstring.
+duplication of information, you can usually find the most detailed
+description in the variables' docstring.
notmuch-hello
=============
|
| All tags: **[show]**
|
-| Type a search query and hit RET to view matching threads.
-| Edit saved searches with the ``edit`` button.
-| Hit RET or click on a saved search or tag name to view matching threads.
-| ``=`` to refresh this screen. ``s`` to search messages. ``q`` to quit.
-| **Customize** this page.
+| Hit \`?' for context-sensitive help in any Notmuch screen.
+| Customize Notmuch or this page.
You can change the overall appearance of the notmuch-hello screen by
customizing the variable :index:`notmuch-hello-sections`.
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 searches. 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
notmuch-show
============
+``notmuch-show-mode`` is used to display a single thread of email from
+your email archives.
+
+By default, various components of email messages, (citations,
+signatures, already-read messages), are hidden. You can make
+these parts visible by clicking with the mouse button or by
+pressing RET after positioning the cursor on a hidden part.
+
+``<space>``
+ Scroll the current message (if necessary),
+ advance to the next message, or advance to the next thread (if
+ already on the last message of a thread).
+
+``N``
+ Move to next message
+
+``P``
+ Move to previous message (or start of current message)
+
+``n``
+ Move to next matching message
+
+``p``
+ Move to previous matching message
+
+``+,-``
+ Add or remove arbitrary tags from the current message.
+
+``?``
+ Display full set of key bindings
+
+.. _notmuch-tree:
+
notmuch-tree
============
+``notmuch-tree-mode`` displays the results of a "notmuch tree" of your
+email archives. Each line in the buffer represents a single
+message giving the relative date, the author, subject, and any
+tags.
+
+``<return>``
+ Displays that message.
+
+``N``
+ Move to next message
+
+``P``
+ Move to previous message
+
+``n``
+ Move to next matching message
+
+``p``
+ Move to previous matching message
+
+``?``
+ Display full set of key bindings
+
+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`.
+
+``k``
+ Tagging operations using :ref:`notmuch-tag-jump`
+
+.. _notmuch-jump:
+
+notmuch-jump
+------------
+
+Saved searches configured through :ref:`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.
+
+.. _notmuch-tag-jump:
+
+notmuch-tag-jump
+----------------
+
+Tagging operations configured through ``notmuch-tagging-keys`` can
+be accessed via :kbd:`k` in :ref:`notmuch-show`,
+:ref:`notmuch-search` and :ref:`notmuch-tree`. With a
+prefix (:kbd:`C-u k`), notmuch displays a menu of the reverses of the
+operations specified in ``notmuch-tagging-keys``; i.e. each
+``+tag`` is replaced by ``-tag`` and vice versa.
+
+:index:`notmuch-tagging-keys`
+
+ A list of keys and corresponding tagging operations.
+
Configuration
=============
projects / notmuch / blobdiff