]> git.cworth.org Git - notmuch/commitdiff
docs: add initial documentation for notmuch-tag-jump
authorDavid Bremner <david@tethera.net>
Mon, 21 May 2018 20:08:56 +0000 (13:08 -0700)
committerDavid Bremner <david@tethera.net>
Sat, 26 May 2018 15:31:03 +0000 (08:31 -0700)
This is mainly to improve discoverability. It seems that doing
variable cross-references is not easy without using some sphinx
extension/customization.

doc/notmuch-emacs.rst

index 1d3291b8fa9c4034bd19861d73e04c4ef937a5f4..ce2e358e2134e2dfb4c86a2fe89f2d00a7eb4f45 100644 (file)
@@ -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
 =============