From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH] doc/emacs: start a section on notmuch-message-mode
Date: Tue, 13 Aug 2024 21:08:05 -0300 [thread overview]
Message-ID: <20240814000805.1925418-1-david@tethera.net> (raw)
This is mostly just copying docstrings, but putting them into sections
makes them more discoverable.
---
doc/conf.py | 2 +-
doc/notmuch-emacs.rst | 57 ++++++++++++++++++++++++++++++++++++-------
2 files changed, 49 insertions(+), 10 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index ee1b336a..5270011d 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -47,7 +47,7 @@ if tags.has('WITH_EMACS'):
# Hacky reimplementation of include to workaround limitations of
# sphinx-doc
lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
- for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-hello.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'):
+ for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-hello.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti', 'notmuch-maildir-fcc.rsti'):
lines.extend(open(rsti_dir+'/'+file))
rst_epilog = ''.join(lines)
del lines
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
index 91af6d14..48f87458 100644
--- a/doc/notmuch-emacs.rst
+++ b/doc/notmuch-emacs.rst
@@ -671,6 +671,54 @@ Keybindings are the same as :any:`notmuch-tree`.
See also :el:defcustom:`notmuch-search-result-format` and
:el:defcustom:`notmuch-tree-result-format`.
+notmuch-message
+===============
+
+Notmuch uses a slighly customized version of the standard emacs email
+composition mode info:message.
+
+.. _notmuch-emacs-drafts:
+
+Drafts
+------
+
+.. el:define-key:: C-x C-p
+ M-x notmuch-draft-postpone
+
+ Postpone (save and bury) a draft.
+
+.. el:define-key:: C-x C-s
+ M-x notmuch-draft-save
+
+ Save a draft and continue editing.
+
+.. _notmuch-emacs-replies:
+
+.. _notmuch-emacs-fcc:
+
+Fcc
+---
+
+.. el:defcustom:: notmuch-fcc-dirs
+
+ |docstring::notmuch-fcc-dirs|
+
+.. el:defcustom:: notmuch-maildir-use-notmuch-insert
+
+ |docstring::notmuch-maildir-use-notmuch-insert|
+
+Replies
+-------
+
+.. el:defcustom:: message-dont-reply-to-names
+
+ When composing mail replies, Emacs's message mode uses the
+ variable :code:`message-dont-reply-to-names` to exclude
+ recipients matching a given collection of regular expressions
+ or satisfying an arbitrary predicate. Notmuch's MUA inherits
+ this standard mechanism and will honour your customization of
+ this variable.
+
Global key bindings
===================
@@ -770,15 +818,6 @@ Sending Mail
:code:`compose-mail`. To use ``notmuch`` for this, customize this
variable to the symbol :code:`notmuch-user-agent`.
-.. el:defcustom:: message-dont-reply-to-names
-
- When composing mail replies, Emacs's message mode uses the
- variable :code:`message-dont-reply-to-names` to exclude
- recipients matching a given collection of regular expressions
- or satisfying an arbitrary predicate. Notmuch's MUA inherits
- this standard mechanism and will honour your customization of
- this variable.
-
Init File
---------
--
2.43.0
next reply other threads:[~2024-08-14 0:08 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-14 0:08 David Bremner [this message]
2024-08-14 10:57 ` [PATCH] emacs/doc: start subsection on message level actions David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240814000805.1925418-1-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).