X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fnotmuch-emacs.rst;h=0df46df9e700fd1bd5bc046697b1247d8bfa9646;hp=5e25996f69b4e9c7f03ab340bba941b78d4c45ef;hb=71eaa19350883b30bafe885ea083c2e3f1621e10;hpb=d35c2c15f61cb527eea6e6224d8b0ad965100766 diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst index 5e25996f..0df46df9 100644 --- a/doc/notmuch-emacs.rst +++ b/doc/notmuch-emacs.rst @@ -62,6 +62,7 @@ notmuch-hello key bindings ```` Activate the current widget. +``g`` ``=`` Refresh the buffer; mainly update the counts of messages for various saved searches. @@ -159,6 +160,10 @@ menu of results that the user can explore further by pressing ```` Open thread on current line in :ref:`notmuch-show` mode +``g`` +``=`` + Refresh the buffer + ``?`` Display full set of key bindings @@ -177,9 +182,132 @@ variables. 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. + +```` + 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`` + :ref:`show-copy` + +``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 + +Display of messages can be controlled by the following variables + +:index:`notmuch-message-headers` + |docstring::notmuch-message-headers| + +:index:`notmuch-message-headers-visible` + |docstring::notmuch-message-headers-visible| + +.. _show-copy: + +Copy to kill-ring +----------------- + +You can use the usually Emacs ways of copying text to the kill-ring, +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`` + |docstring::notmuch-show-stash-filename| + +``c G`` ``notmuch-show-stash-git-send-email`` + |docstring::notmuch-show-stash-git-send-email| + +``c I`` ``notmuch-show-stash-message-id-stripped`` + |docstring::notmuch-show-stash-message-id-stripped| + +``c L`` ``notmuch-show-stash-mlarchive-link-and-go`` + |docstring::notmuch-show-stash-mlarchive-link-and-go| + +``c T`` ``notmuch-show-stash-tags`` + |docstring::notmuch-show-stash-tags| + +``c c`` ``notmuch-show-stash-cc`` + |docstring::notmuch-show-stash-cc| + +``c d`` ``notmuch-show-stash-date`` + |docstring::notmuch-show-stash-date| + +``c f`` ``notmuch-show-stash-from`` + |docstring::notmuch-show-stash-from| + +``c i`` ``notmuch-show-stash-message-id`` + |docstring::notmuch-show-stash-message-id| + +``c l`` ``notmuch-show-stash-mlarchive-link`` + |docstring::notmuch-show-stash-mlarchive-link| + +``c s`` ``notmuch-show-stash-subject`` + |docstring::notmuch-show-stash-subject| + +``c t`` ``notmuch-show-stash-to`` + |docstring::notmuch-show-stash-to| + +``c ?`` + Show all available copying commands + +.. _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. + +``c`` + :ref:`show-copy` + +```` + 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 + +``g`` +``=`` + Refresh the buffer + +``?`` + Display full set of key bindings + Global key bindings =================== @@ -189,6 +317,9 @@ following key bindings: ``j`` Jump to saved searches using :ref:`notmuch-jump`. +``k`` + Tagging operations using :ref:`notmuch-tag-jump` + .. _notmuch-jump: notmuch-jump @@ -202,6 +333,28 @@ 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` + + |docstring::notmuch-tagging-keys| + +Buffer navigation +================= + +:index:`notmuch-cycle-notmuch-buffers` + |docstring::notmuch-cycle-notmuch-buffers| + Configuration ============= @@ -211,8 +364,10 @@ Importing Mail -------------- :index:`notmuch-poll` + |docstring::notmuch-poll| :index:`notmuch-poll-script` + |docstring::notmuch-poll-script| Init File --------- @@ -225,3 +380,13 @@ 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. + +.. include:: ../emacs/rstdoc.rsti + +.. include:: ../emacs/notmuch.rsti + +.. include:: ../emacs/notmuch-lib.rsti + +.. include:: ../emacs/notmuch-show.rsti + +.. include:: ../emacs/notmuch-tag.rsti