8 This manual covers only the Emacs interface to Notmuch. For information
9 on the command line interface, see section “Description” in the Notmuch
10 Manual Pages. To save typing, we will sometimes use *notmuch* in this
11 manual to refer to the Emacs interface to Notmuch. When this distinction
12 is important, we’ll refer to the Emacs interface as
15 Notmuch-emacs is highly customizable via the the Emacs customization
16 framework (or just by setting the appropriate variables). We try to
17 point out relevant variables in this manual, but in order to avoid
18 duplication of information, you can usually find the most detailed
19 description in the variables' docstring.
28 ``notmuch-hello`` is the main entry point for Notmuch. You can start it
29 with ``M-x notmuch`` or ``M-x notmuch-hello``. The startup screen looks
30 something like the following. There are some hints at the bottom of the
31 screen. There are three main parts to the notmuch-hello screen,
32 discussed below. The **bold** text indicates buttons you can click with
33 a mouse or by positioning the cursor and pressing ``<return>``
35 | Welcome to **notmuch** You have 52 messages.
37 | Saved searches: **[edit]**
39 | 52 **inbox** 52 **unread**
41 | Search: ____________________________________
43 | All tags: **[show]**
45 | Hit \`?' for context-sensitive help in any Notmuch screen.
46 | Customize Notmuch or this page.
48 You can change the overall appearance of the notmuch-hello screen by
49 customizing the variable :index:`notmuch-hello-sections`.
53 notmuch-hello key bindings
54 --------------------------
57 Move to the next widget (button or text entry field)
60 Move to the previous widget.
63 Activate the current widget.
66 Refresh the buffer; mainly update the counts of messages for various
70 Import mail, See :ref:`importing`
76 Search the notmuch database using :ref:`notmuch-search`
89 Since notmuch is entirely search-based, it's often useful to organize
90 mail around common searches. To facilitate this, the first section of
91 notmuch-hello presents a customizable set of saved searches. Saved
92 searches can also be accessed from anywhere in notmuch by pressing
93 ``j`` to access :ref:`notmuch-jump`.
95 The saved searches default to various common searches such as
96 ``tag:inbox`` to access the inbox and ``tag:unread`` to access all
97 unread mail, but there are several options for customization:
99 :index:`notmuch-saved-searches`
100 The list of saved searches, including names, queries, and
101 additional per-query options.
103 :index:`notmuch-saved-searches-sort-function`
104 This variable controls how saved searches should be sorted. A value
105 of ``nil`` displays the saved searches in the order they are stored
106 in ‘notmuch-saved-searches’.
108 :index:`notmuch-column-control`
109 Controls the number of columns for displaying saved-searches/tags
114 The search box lets the user enter a Notmuch query. See section
115 “Description” in Notmuch Query Syntax, for more info on Notmuch query
116 syntax. A history of recent searches is also displayed by default. The
117 latter is controlled by the variable :index:`notmuch-hello-recent-searches-max`.
122 One special kind of saved search provided by default is for each
123 individual tag defined in the database. This can be controlled via the
126 :index:`notmuch-hello-tag-list-make-query`
127 Control how to construct a search (“virtual folder”) from a given
130 :index:`notmuch-hello-hide-tags`
131 Which tags not to display at all.
133 :index:`notmuch-column-control`
134 Controls the number of columns for displaying saved-searches/tags
141 ``notmuch-search-mode`` is used to display the results from executing
142 a query via ``notmuch-search``. The syntax for these queries is the
143 the same as :ref:`saved-searches`. For details of this syntax see
144 info:notmuch-search-terms
146 By default the output approximates that of the command line See section
147 “Description” in notmuch search command.
149 The main purpose of the ``notmuch-search-mode`` buffer is to act as a
150 menu of results that the user can explore further by pressing
151 ``<return>`` on the appropriate line.
157 Move to previous line
160 Open thread on current line in :ref:`notmuch-show` mode
163 Display full set of key bindings
165 The presentation of results can be controlled by the following
168 :index:`notmuch-search-result-format`
169 Control how each thread of messages is presented in the
170 ``notmuch-show-mode`` buffer
172 :index:`notmuch-search-oldest-first`
173 Display the oldest threads at the top of the buffer
180 ``notmuch-show-mode`` is used to display a single thread of email from
183 By default, various components of email messages, (citations,
184 signatures, already-read messages), are hidden. You can make
185 these parts visible by clicking with the mouse button or by
186 pressing RET after positioning the cursor on a hidden part.
189 Scroll the current message (if necessary),
190 advance to the next message, or advance to the next thread (if
191 already on the last message of a thread).
200 Move to previous message (or start of current message)
203 Move to next matching message
206 Move to previous matching message
209 Add or remove arbitrary tags from the current message.
212 Display full set of key bindings
214 Display of messages can be controlled by the following variables
216 :index:`notmuch-message-headers`
217 |docstring::notmuch-message-headers|
219 :index:`notmuch-message-headers-visible`
220 |docstring::notmuch-message-headers-visible|
227 You can use the usually Emacs ways of copying text to the kill-ring,
228 but notmuch also provides some shortcuts. These keys are available in
229 :ref:`notmuch-show`, and :ref:`notmuch-tree`. A subset are available
230 in :ref:`notmuch-search`.
232 ``c F`` ``notmuch-show-stash-filename``
233 |docstring::notmuch-show-stash-filename|
235 ``c G`` ``notmuch-show-stash-git-send-email``
236 |docstring::notmuch-show-stash-git-send-email|
238 ``c I`` ``notmuch-show-stash-message-id-stripped``
239 |docstring::notmuch-show-stash-message-id-stripped|
241 ``c L`` ``notmuch-show-stash-mlarchive-link-and-go``
242 |docstring::notmuch-show-stash-mlarchive-link-and-go|
244 ``c T`` ``notmuch-show-stash-tags``
245 |docstring::notmuch-show-stash-tags|
247 ``c c`` ``notmuch-show-stash-cc``
248 |docstring::notmuch-show-stash-cc|
250 ``c d`` ``notmuch-show-stash-date``
251 |docstring::notmuch-show-stash-date|
253 ``c f`` ``notmuch-show-stash-from``
254 |docstring::notmuch-show-stash-from|
256 ``c i`` ``notmuch-show-stash-message-id``
257 |docstring::notmuch-show-stash-message-id|
259 ``c l`` ``notmuch-show-stash-mlarchive-link``
260 |docstring::notmuch-show-stash-mlarchive-link|
262 ``c s`` ``notmuch-show-stash-subject``
263 |docstring::notmuch-show-stash-subject|
265 ``c t`` ``notmuch-show-stash-to``
266 |docstring::notmuch-show-stash-to|
269 Show all available copying commands
276 ``notmuch-tree-mode`` displays the results of a "notmuch tree" of your
277 email archives. Each line in the buffer represents a single
278 message giving the relative date, the author, subject, and any
285 Displays that message.
291 Move to previous message
294 Move to next matching message
297 Move to previous matching message
300 Display full set of key bindings
305 Several features are accessible from anywhere in notmuch through the
306 following key bindings:
309 Jump to saved searches using :ref:`notmuch-jump`.
312 Tagging operations using :ref:`notmuch-tag-jump`
319 Saved searches configured through :ref:`saved-searches` can
320 include a "shortcut key" that's accessible through notmuch-jump.
321 Pressing ``j`` anywhere in notmuch followed by the configured shortcut
322 key of a saved search will immediately jump to that saved search. For
323 example, in the default configuration ``j i`` jumps immediately to the
324 inbox search. When you press ``j``, notmuch-jump shows the saved
325 searches and their shortcut keys in the mini-buffer.
327 .. _notmuch-tag-jump:
332 Tagging operations configured through ``notmuch-tagging-keys`` can
333 be accessed via :kbd:`k` in :ref:`notmuch-show`,
334 :ref:`notmuch-search` and :ref:`notmuch-tree`. With a
335 prefix (:kbd:`C-u k`), notmuch displays a menu of the reverses of the
336 operations specified in ``notmuch-tagging-keys``; i.e. each
337 ``+tag`` is replaced by ``-tag`` and vice versa.
339 :index:`notmuch-tagging-keys`
341 |docstring::notmuch-tagging-keys|
346 :index:`notmuch-cycle-notmuch-buffers`
347 |docstring::notmuch-cycle-notmuch-buffers|
357 :index:`notmuch-poll`
358 |docstring::notmuch-poll|
360 :index:`notmuch-poll-script`
361 |docstring::notmuch-poll-script|
366 When Notmuch is loaded, it will read the ``notmuch-init-file``
367 (``~/.emacs.d/notmuch-config`` by default) file. This is normal Emacs Lisp
368 file and can be used to avoid cluttering your ``~/.emacs`` with Notmuch
369 stuff. If the file with ``.elc``, ``.elc.gz``, ``.el`` or ``.el.gz``
370 suffix exist it will be read instead (just one of these, chosen in this
371 order). Most often users create ``~/.emacs.d/notmuch-config.el`` and just
372 work with it. If Emacs was invoked with the ``-q`` or ``--no-init-file``
373 options, ``notmuch-init-file`` is not read.
375 .. include:: ../emacs/rstdoc.rsti
377 .. include:: ../emacs/notmuch.rsti
379 .. include:: ../emacs/notmuch-lib.rsti
381 .. include:: ../emacs/notmuch-show.rsti
383 .. include:: ../emacs/notmuch-tag.rsti