X-Git-Url: https://git.cworth.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fnotmuch-emacs.rst;h=67dbfc2bf3b135b7c070c314e5e946f17da244ec;hp=e69bd23da5cf69b343ff69ad4506fc408ab5e0a2;hb=HEAD;hpb=f4ebb6037529569875029f411fd062d79641ce14 diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst index e69bd23d..91af6d14 100644 --- a/doc/notmuch-emacs.rst +++ b/doc/notmuch-emacs.rst @@ -14,7 +14,7 @@ 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 +Notmuch-emacs is highly customizable via 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, you can usually find the most detailed @@ -50,19 +50,19 @@ a mouse or by positioning the cursor and pressing ```` You can change the overall appearance of the notmuch-hello screen by customizing the variables -.. emacsvar:: notmuch-hello-sections +.. el:defcustom:: notmuch-hello-sections |docstring::notmuch-hello-sections| -.. emacsvar:: notmuch-hello-thousands-separator +.. el:defcustom:: notmuch-hello-thousands-separator |docstring::notmuch-hello-thousands-separator| -.. emacsvar:: notmuch-show-logo +.. el:defcustom:: notmuch-show-logo |docstring::notmuch-show-logo| -.. emacsvar:: notmuch-column-control +.. el:defcustom:: notmuch-column-control Controls the number of columns for saved searches/tags in notmuch view. @@ -94,39 +94,49 @@ customizing the variables - if you don't want to worry about all of this nonsense, leave this set to `t`. -.. emacsvar:: notmuch-show-empty-saved-searches +.. el:defcustom:: notmuch-show-empty-saved-searches |docstring::notmuch-show-empty-saved-searches| notmuch-hello key bindings -------------------------- -```` +.. el:define-key:: + Move to the next widget (button or text entry field) -```` +.. el:define-key:: + Move to the previous widget. -```` +.. el:define-key:: + Activate the current widget. -``g`` ``=`` +.. el:define-key:: g + = + Refresh the buffer; mainly update the counts of messages for various saved searches. -``G`` +.. el:define-key:: G + Import mail, See :ref:`importing` -``m`` +.. el:define-key:: m + Compose a message -``s`` +.. el:define-key:: s + Search the notmuch database using :ref:`notmuch-search` -``v`` +.. el:define-key:: v + Print notmuch version -``q`` +.. el:define-key:: q + Quit .. _saved-searches: @@ -144,12 +154,12 @@ 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: -.. emacsvar:: notmuch-saved-searches +.. el:defcustom:: notmuch-saved-searches The list of saved searches, including names, queries, and additional per-query options. -.. emacsvar:: notmuch-saved-search-sort-function +.. el:defcustom:: notmuch-saved-search-sort-function This variable controls how saved searches should be sorted. A value of ``nil`` displays the saved searches in the order they are stored @@ -163,7 +173,7 @@ The search box lets the user enter a Notmuch query. See section syntax. A history of recent searches is also displayed by default. The latter is controlled by the variable `notmuch-hello-recent-searches-max`. -.. emacsvar:: notmuch-hello-recent-searches-max +.. el:defcustom:: notmuch-hello-recent-searches-max |docstring::notmuch-hello-recent-searches-max| @@ -174,12 +184,12 @@ One special kind of saved search provided by default is for each individual tag defined in the database. This can be controlled via the following variables. -.. emacsvar:: notmuch-hello-tag-list-make-query +.. el:defcustom:: notmuch-hello-tag-list-make-query Control how to construct a search (“virtual folder”) from a given tag. -.. emacsvar:: notmuch-hello-hide-tags +.. el:defcustom:: notmuch-hello-hide-tags Which tags not to display at all. @@ -200,25 +210,40 @@ The main purpose of the ``notmuch-search-mode`` buffer is to act as a menu of results that the user can explore further by pressing ```` on the appropriate line. -``n,C-n,`` +.. el:define-key:: n + C-n + + Move to next line -``p,C-p,`` +.. el:define-key:: + p + C-p + + Move to previous line -```` +.. el:define-key:: + Open thread on current line in :ref:`notmuch-show` mode -``g`` ``=`` +.. el:define-key:: g + = + Refresh the buffer -``?`` +.. el:define-key:: i + + Toggle whether to show messages with excluded tags in search results. + +.. el:define-key:: ? + Display full set of key bindings The presentation of results can be controlled by the following variables. -.. emacsvar:: notmuch-search-result-format +.. el:defcustom:: notmuch-search-result-format |docstring::notmuch-search-result-format| @@ -253,21 +278,21 @@ variables. ("subject" . "%s ") ("tags" . "(%s)"))) - See also :emacsvar:`notmuch-tree-result-format` and - :emacsvar:`notmuch-unthreaded-result-format`. + See also :el:defcustom:`notmuch-tree-result-format` and + :el:defcustom:`notmuch-unthreaded-result-format`. -.. emacsvar:: notmuch-search-oldest-first +.. el:defcustom:: notmuch-search-oldest-first Display the oldest threads at the top of the buffer It is also possible to customize how the name of buffers containing search results is formatted using the following variables: -.. emacsvar:: notmuch-search-buffer-name-format +.. el:defcustom:: notmuch-search-buffer-name-format |docstring::notmuch-search-buffer-name-format| -.. emacsvar:: notmuch-saved-search-buffer-name-format +.. el:defcustom:: notmuch-saved-search-buffer-name-format |docstring::notmuch-saved-search-buffer-name-format| @@ -285,50 +310,60 @@ 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. -```` +.. el:define-key:: + 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). -``c`` +.. el:define-key:: c + :ref:`show-copy` -``N`` +.. el:define-key:: N + Move to next message -``P`` +.. el:define-key:: P + Move to previous message (or start of current message) -``n`` +.. el:define-key:: n + Move to next matching message -``p`` +.. el:define-key:: p + Move to previous matching message -``+,-`` +.. el:define-key:: + + - + Add or remove arbitrary tags from the current message. -``!`` +.. el:define-key:: ! + |docstring::notmuch-show-toggle-elide-non-matching| -``?`` +.. el:define-key:: ? + Display full set of key bindings Display of messages can be controlled by the following variables; see also :ref:`show-large`. -.. emacsvar:: notmuch-message-headers +.. el:defcustom:: notmuch-message-headers |docstring::notmuch-message-headers| -.. emacsvar:: notmuch-message-headers-visible +.. el:defcustom:: notmuch-message-headers-visible |docstring::notmuch-message-headers-visible| -.. emacsvar:: notmuch-show-header-line +.. el:defcustom:: notmuch-show-header-line |docstring::notmuch-show-header-line| -.. emacsvar:: notmuch-multipart/alternative-discouraged +.. el:defcustom:: notmuch-multipart/alternative-discouraged Which mime types to hide by default for multipart messages. @@ -356,7 +391,7 @@ Dealing with large messages and threads If you are finding :ref:`notmuch-show` is annoyingly slow displaying large messages, you can customize -:emacsvar:`notmuch-show-max-text-part-size`. If you want to speed up the +:el:defcustom:`notmuch-show-max-text-part-size`. If you want to speed up the display of large threads (with or without large messages), there are several options. First, you can display the same query in one of the other modes. :ref:`notmuch-unthreaded` is the most robust for @@ -364,21 +399,21 @@ extremely large queries, but :ref:`notmuch-tree` is also be faster than :ref:`notmuch-show` in general, since it only renders a single message a time. If you prefer to stay with the rendered thread ("conversation") view of :ref:`notmuch-show`, you can customize the -variables :emacsvar:`notmuch-show-depth-limit`, -:emacsvar:`notmuch-show-height-limit` and -:emacsvar:`notmuch-show-max-text-part-size` to limit the amount of +variables :el:defcustom:`notmuch-show-depth-limit`, +:el:defcustom:`notmuch-show-height-limit` and +:el:defcustom:`notmuch-show-max-text-part-size` to limit the amount of rendering done initially. Note that these limits are implicitly *OR*-ed together, and combinations might have surprising effects. -.. emacsvar:: notmuch-show-depth-limit +.. el:defcustom:: notmuch-show-depth-limit |docstring::notmuch-show-depth-limit| -.. emacsvar:: notmuch-show-height-limit +.. el:defcustom:: notmuch-show-height-limit |docstring::notmuch-show-height-limit| -.. emacsvar:: notmuch-show-max-text-part-size +.. el:defcustom:: notmuch-show-max-text-part-size |docstring::notmuch-show-max-text-part-size| @@ -392,44 +427,92 @@ but notmuch also provides some shortcuts. These keys are available in :ref:`notmuch-show`, and :ref:`notmuch-tree`. A subset are available in :ref:`notmuch-search`. -``c F`` ``notmuch-show-stash-filename`` +.. el:define-key:: c F + M-x notmuch-show-stash-filename + |docstring::notmuch-show-stash-filename| -``c G`` ``notmuch-show-stash-git-send-email`` +.. el:define-key:: c G + M-x notmuch-show-stash-git-send-email + |docstring::notmuch-show-stash-git-send-email| -``c I`` ``notmuch-show-stash-message-id-stripped`` +.. el:define-key:: c I + M-x notmuch-show-stash-message-id-stripped + |docstring::notmuch-show-stash-message-id-stripped| -``c L`` ``notmuch-show-stash-mlarchive-link-and-go`` +.. el:define-key:: c L + M-x notmuch-show-stash-mlarchive-link-and-go + |docstring::notmuch-show-stash-mlarchive-link-and-go| -``c T`` ``notmuch-show-stash-tags`` +.. el:define-key:: c T + M-x notmuch-show-stash-tags + |docstring::notmuch-show-stash-tags| -``c c`` ``notmuch-show-stash-cc`` +.. el:define-key:: c c + M-x notmuch-show-stash-cc + |docstring::notmuch-show-stash-cc| -``c d`` ``notmuch-show-stash-date`` +.. el:define-key:: c d + M-x notmuch-show-stash-date + |docstring::notmuch-show-stash-date| -``c f`` ``notmuch-show-stash-from`` +.. el:define-key:: c f + M-x notmuch-show-stash-from + |docstring::notmuch-show-stash-from| -``c i`` ``notmuch-show-stash-message-id`` +.. el:define-key:: c i + M-x notmuch-show-stash-message-id + |docstring::notmuch-show-stash-message-id| -``c l`` ``notmuch-show-stash-mlarchive-link`` +.. el:define-key:: c l + M-x notmuch-show-stash-mlarchive-link + |docstring::notmuch-show-stash-mlarchive-link| -``c s`` ``notmuch-show-stash-subject`` +.. el:define-key:: c s + M-x notmuch-show-stash-subject + |docstring::notmuch-show-stash-subject| -``c t`` ``notmuch-show-stash-to`` +.. el:define-key:: c t + M-x notmuch-show-stash-to + |docstring::notmuch-show-stash-to| -``c ?`` - Show all available copying commands +.. el:define-key:: c ? + M-x notmuch-subkeymap-help + + Show all available copying commands + +.. _emacs-show-duplicates: + +Dealing with duplicates +----------------------- + +If there are multiple files with the same :mailheader:`Message-ID` +(see :any:`duplicate-files`), then :any:`notmuch-show` displays the +number of duplicates and identifies the current duplicate. In the +following example duplicate 3 of 5 is displayed. + +.. code-block:: + :emphasize-lines: 1 + + M. Mustermann (Sat, 30 Jul 2022 10:33:10 -0300) (inbox signed) 3/5 + Subject: Re: Multiple files per message in emacs + To: notmuch@notmuchmail.org + +.. el:define-key:: % + M-x notmuch-show-choose-duplicate + + |docstring::notmuch-show-choose-duplicate| .. _notmuch-tree: @@ -441,44 +524,62 @@ email archives. Each line in the buffer represents a single message giving the relative date, the author, subject, and any tags. -``c`` +.. el:define-key:: c + :ref:`show-copy` -```` +.. el:define-key:: + Displays that message. -``N`` +.. el:define-key:: N + Move to next message -``P`` +.. el:define-key:: P + Move to previous message -``n`` +.. el:define-key:: n + Move to next matching message -``p`` +.. el:define-key:: p + Move to previous matching message -``o`` ``notmuch-tree-toggle-order`` +.. el:define-key:: o + M-x notmuch-tree-toggle-order + |docstring::notmuch-tree-toggle-order| -``l`` ``notmuch-tree-filter`` +.. el:define-key:: l + M-x notmuch-tree-filter + Filter or LIMIT the current search results based on an additional query string -``t`` ``notmuch-tree-filter-by-tag`` +.. el:define-key:: t + M-x notmuch-tree-filter-by-tag + Filter the current search results based on an additional tag +.. el:define-key:: i + + Toggle whether to show messages with excluded tags in search results. + +.. el:define-key:: g + = -``g`` ``=`` Refresh the buffer -``?`` +.. el:define-key:: ? + Display full set of key bindings As is the case with :ref:`notmuch-search`, the presentation of results can be controlled by the variable ``notmuch-search-oldest-first``. -.. emacsvar:: notmuch-tree-result-format +.. el:defcustom:: notmuch-tree-result-format |docstring::notmuch-tree-result-format| @@ -509,9 +610,48 @@ can be controlled by the variable ``notmuch-search-oldest-first``. . " %-54s ") ("tags" . "(%s)"))) - See also :emacsvar:`notmuch-search-result-format` and - :emacsvar:`notmuch-unthreaded-result-format`. + See also :el:defcustom:`notmuch-search-result-format` and + :el:defcustom:`notmuch-unthreaded-result-format`. +.. _notmuch-tree-outline: + +notmuch-tree-outline +-------------------- + +When this mode is set, each thread and subthread in the results +list is treated as a foldable section, with its first message as +its header. + +The mode just makes available in the tree buffer all the +keybindings in info:emacs#Outline_Mode, and binds the following +additional keys: + +.. el:define-key:: + + Cycle visibility state of the current message's tree. + +.. el:define-key:: + + Cycle visibility state of all trees in the buffer. + +The behaviour of this minor mode is affected by the following +customizable variables: + +.. el:defcustom:: notmuch-tree-outline-enabled + + |docstring::notmuch-tree-outline-enabled| + +.. el:defcustom:: notmuch-tree-outline-visibility + + |docstring::notmuch-tree-outline-visibility| + +.. el:defcustom:: notmuch-tree-outline-auto-close + + |docstring::notmuch-tree-outline-auto-close| + +.. el:defcustom:: notmuch-tree-outline-open-on-next + + |docstring::notmuch-tree-outline-open-on-next| .. _notmuch-unthreaded: @@ -524,12 +664,12 @@ is presented. Keybindings are the same as :any:`notmuch-tree`. -.. emacsvar:: notmuch-unthreaded-result-format +.. el:defcustom:: notmuch-unthreaded-result-format |docstring::notmuch-unthreaded-result-format| - See also :emacsvar:`notmuch-search-result-format` and - :emacsvar:`notmuch-tree-result-format`. + See also :el:defcustom:`notmuch-search-result-format` and + :el:defcustom:`notmuch-tree-result-format`. Global key bindings =================== @@ -537,13 +677,19 @@ Global key bindings Several features are accessible from most places in notmuch through the following key bindings: -``j`` +.. el:define-key:: j + Jump to saved searches using :ref:`notmuch-jump`. -``k`` +.. el:define-key:: k + Tagging operations using :ref:`notmuch-tag-jump` -``C-_`` ``C-/`` ``C-x u``: Undo previous tagging operation using :ref:`notmuch-tag-undo` +.. el:define-key:: C-_ + C-/ + C-x u + + Undo previous tagging operation using :any:`notmuch-tag-undo` .. _notmuch-jump: @@ -570,29 +716,31 @@ 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. -.. emacsvar:: notmuch-tagging-keys +.. el:defcustom:: notmuch-tagging-keys |docstring::notmuch-tagging-keys| -.. _notmuch-tag-undo: notmuch-tag-undo ---------------- -Each notmuch buffer supporting tagging operations (i.e buffers in +Each notmuch buffer supporting tagging operations (i.e. buffers in :any:`notmuch-show`, :any:`notmuch-search`, :any:`notmuch-tree`, and :any:`notmuch-unthreaded` mode) keeps a local stack of tagging -operations. These can be undone via :emacscmd:`notmuch-tag-undo`. By default +operations. These can be undone via :any:`notmuch-tag-undo`. By default this is bound to the usual Emacs keys for undo. -.. emacscmd:: notmuch-tag-undo +.. el:define-key:: C-_ + C-/ + C-x u + M-x notmuch-tag-undo |docstring::notmuch-tag-undo| Buffer navigation ================= -.. emacscmd:: notmuch-cycle-notmuch-buffers +.. el:define-key:: M-x notmuch-cycle-notmuch-buffers |docstring::notmuch-cycle-notmuch-buffers| @@ -604,25 +752,25 @@ Configuration Importing Mail -------------- -.. emacscmd:: notmuch-poll +.. el:define-key:: M-x notmuch-poll |docstring::notmuch-poll| -.. emacsvar:: notmuch-poll-script +.. el:defcustom:: notmuch-poll-script |docstring::notmuch-poll-script| Sending Mail ------------ -.. emacsvar:: mail-user-agent +.. el:defcustom:: mail-user-agent Emacs consults the variable :code:`mail-user-agent` to choose a mail sending package for commands like :code:`report-emacs-bug` and :code:`compose-mail`. To use ``notmuch`` for this, customize this variable to the symbol :code:`notmuch-user-agent`. -.. emacsvar:: message-dont-reply-to-names +.. el:defcustom:: message-dont-reply-to-names When composing mail replies, Emacs's message mode uses the variable :code:`message-dont-reply-to-names` to exclude