8 This manual covers only the emacs interface to notmuch. For information
9 on the command line interface, see See section “Description” in Notmuch
10 Manual Pager. To save typing, we will sometimes use *notmuch* in this
11 manual to refer to the Emacs interface to notmuch. If the distinction
12 should every be important, we’ll refer to the Emacs inteface 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, but you can usually find the most detailed
19 description in the varables 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 | Type a search query and hit RET to view matching threads.
46 | Edit saved searches with the ``edit`` button.
47 | Hit RET or click on a saved search or tag name to view matching threads.
48 | ``=`` to refresh this screen. ``s`` to search messages. ``q`` to quit.
49 | **Customize** this page.
51 You can change the overall appearence of the notmuch-hello screen by
52 customizing the variable :index:`notmuch-hello-sections`.
56 notmuch-hello key bindings
57 --------------------------
60 Move to the next widget (button or text entry field)
63 Move to the previous widget.
66 Activate the current widget.
69 Refresh the buffer; mainly update the counts of messages for various
73 Import mail, See :ref:`importing`
79 Search the notmuch database using :ref:`notmuch-search`
92 Notmuch replaces the static assignment of messages with the more dynamic
93 notion of searching. Notmuch-hello presents the user with a customizable
94 set of saved searchs. The initial defaults are ``tag:inbox`` and
95 ``tag:unread``, but you can customize the following variables
97 :index:`notmuch-saved-searches`
98 A list of cons pairs, the first being the name to display, the
99 second being a query string for notmuch. See section “Description”
100 in Notmuch Query Syntax.
102 :index:`notmuch-saved-searches-sort-function`
103 This variable controls how saved searches should be sorted. A value
104 of ``nil`` displays the saved searches in the order they are stored
105 in ‘notmuch-saved-searches’.
107 :index:`notmuch-column-control`
108 Controls the number of columns for displaying saved-searches/tags
113 The search box lets the user enter an notmuch query. See section
114 “Description” in Notmuch Query Syntax, for more info on notmuch query
115 syntax. A history of recent searches is also displayed by default. The
116 latter is controlled by the variable :index:`notmuch-hello-recent-searches-max`.
121 One special kind of saved search provided by default is for each
122 individual tag defined in the database. This can be controlled via the
125 :index:`notmuch-hello-tag-list-make-query`
126 Control how to construct a search (“virtual folder”) from a given
129 :index:`notmuch-hello-hide-tags`
130 Which tags not to display at all.
132 :index:`notmuch-column-control`
133 Controls the number of columns for displaying saved-searches/tags
140 ``notmuch-search-mode`` is used to display the results from executing
141 a query via ``notmuch-search``. The syntax for these queries is the
142 the same as :ref:`saved-searches`. For details of this syntax see
143 info:notmuch-search-terms
145 By default the output approximates that of the command line See section
146 “Description” in notmuch search command.
148 The main purpose of the ``notmuch-search-mode`` buffer is to act as a
149 menu of results that the user can explore further by pressing
150 ``<return>`` on the appropriate line.
156 Move to previous line
159 Open thread on current line in :ref:`notmuch-show` mode
162 Display full set of key bindings
164 The presentation of results can be controlled by the following
167 :index:`notmuch-search-result-format`
168 Control how each thread of messages is presented in the
169 ``notmuch-show-mode`` buffer
171 :index:`notmuch-search-oldest-first`
172 Display the oldest threads at the top of the buffer
190 :index:`notmuch-poll`
192 :index:`notmuch-poll-script`