this is still pretty much proof of concept. It needs guarding against the no-emacs case. --- doc/Makefile.local | 4 +-- doc/notmuch-emacs.rst | 81 ++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 79 insertions(+), 6 deletions(-) diff --git a/doc/Makefile.local b/doc/Makefile.local index 16459e35..c0db2bc9 100644 --- a/doc/Makefile.local +++ b/doc/Makefile.local @@ -37,10 +37,10 @@ INFO_INFO_FILES := $(INFO_TEXI_FILES:.texi=.info) %.gz: % rm -f $@ && gzip --stdout $^ > $@ -sphinx-html: +sphinx-html: ${emacs_docstrings} $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html -sphinx-texinfo: +sphinx-texinfo: ${emacs_docstrings} $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo sphinx-info: sphinx-texinfo diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst index ce2e358e..47bd6102 100644 --- a/doc/notmuch-emacs.rst +++ b/doc/notmuch-emacs.rst @@ -36,14 +36,14 @@ a mouse or by positioning the cursor and pressing ``<return>`` | | Saved searches: **[edit]** | -| 52 **inbox** 52 **unread** +| 52 **inbox** 52 **unread** | | Search: ____________________________________ | | All tags: **[show]** | -| Hit \`?' for context-sensitive help in any Notmuch screen. -| Customize Notmuch or this page. +| Hit \`?' for context-sensitive help in any Notmuch screen. +| Customize Notmuch or this page. You can change the overall appearance of the notmuch-hello screen by customizing the variable :index:`notmuch-hello-sections`. @@ -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 already on the last message of a thread). +``c`` + :ref:`show-copy` + ``N`` Move to next message @@ -208,6 +211,63 @@ pressing RET after positioning the cursor on a hidden part. ``?`` 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 @@ -218,6 +278,9 @@ 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` + ``<return>`` Displays that message. @@ -275,7 +338,7 @@ operations specified in ``notmuch-tagging-keys``; i.e. each :index:`notmuch-tagging-keys` - A list of keys and corresponding tagging operations. + |docstring::notmuch-tagging-keys| Configuration ============= @@ -286,8 +349,10 @@ Importing Mail -------------- :index:`notmuch-poll` + |docstring::notmuch-poll| :index:`notmuch-poll-script` + |docstring::notmuch-poll-script| Init File --------- @@ -300,3 +365,11 @@ 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-lib.rsti + +.. include:: ../emacs/notmuch-show.rsti + +.. include:: ../emacs/notmuch-tag.rsti -- 2.17.0 _______________________________________________ notmuch mailing list notmuch@notmuchmail.org https://notmuchmail.org/mailman/listinfo/notmuch