doc/emacs: add documentation for stashing 'c X' bindings

This is the first of a series of changes requiring the extracted docstrings.
This commit is contained in:
David Bremner 2018-06-13 21:32:41 -03:00
parent 0601d2337e
commit 241373cd3f

View file

@ -190,6 +190,9 @@ pressing RET after positioning the cursor on a hidden part.
advance to the next message, or advance to the next thread (if advance to the next message, or advance to the next thread (if
already on the last message of a thread). already on the last message of a thread).
``c``
:ref:`show-copy`
``N`` ``N``
Move to next message Move to next message
@ -208,6 +211,55 @@ pressing RET after positioning the cursor on a hidden part.
``?`` ``?``
Display full set of key bindings Display full set of key bindings
.. _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 notmuch-tree
@ -218,6 +270,9 @@ email archives. Each line in the buffer represents a single
message giving the relative date, the author, subject, and any message giving the relative date, the author, subject, and any
tags. tags.
``c``
:ref:`show-copy`
``<return>`` ``<return>``
Displays that message. Displays that message.
@ -300,3 +355,8 @@ 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 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`` work with it. If Emacs was invoked with the ``-q`` or ``--no-init-file``
options, ``notmuch-init-file`` is not read. options, ``notmuch-init-file`` is not read.
.. include:: ../emacs/rstdoc.rsti
.. include:: ../emacs/notmuch-show.rsti