summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2018-05-21 13:08:56 -0700
committerDavid Bremner <david@tethera.net>2018-05-26 08:31:03 -0700
commitb50fb1b642be5f418db56f00f4518b1d3b2c83eb (patch)
treeb347a986b8e9deac133d6f8406ae6855b3554167 /doc
parent7a58c1c44bfc31aea4b4b8698c2941365f3e65b6 (diff)
docs: add initial documentation for notmuch-tag-jump
This is mainly to improve discoverability. It seems that doing variable cross-references is not easy without using some sphinx extension/customization.
Diffstat (limited to 'doc')
-rw-r--r--doc/notmuch-emacs.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
index 1d3291b8..ce2e358e 100644
--- a/doc/notmuch-emacs.rst
+++ b/doc/notmuch-emacs.rst
@@ -245,6 +245,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
@@ -258,6 +261,22 @@ 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
=============