aboutsummaryrefslogtreecommitdiff
path: root/doc/notmuch-emacs.rst
AgeCommit message (Collapse)Author
2026-01-24doc/emacs: correct documentation of n-show-forward-messageDavid Bremner
Commit 3af10307d started a subsection on message level actions, but the author (yours truly) mistook their customized behaviour for the default.
2025-06-22doc/emacs: start subsection on message level actionsDavid Bremner
In particular this gives a place for documenting how to resume editing drafts.
2025-06-22doc/emacs: refactor navigation commandsDavid Bremner
The amount of space saved here is minimal, but I want to migrate to a more topic focused manual, as opposed to long alphabetical lists of commands.
2025-06-22doc/emacs: start a section on notmuch-message-modeDavid Bremner
This is mostly just copying docstrings, but putting them into sections makes them more discoverable.
2024-04-06emacs: Add new option notmuch-search-hide-excludedMohsin Kaleem
The new notmuch-search-hide-excluded option allows users to configure whether to show or hide excluded messages (as determined by search.exclude_tags in the local notmuch config file). It defaults to true for now to maintain backwards-compatibility with how notmuch-{search,tree} already worked. New commands notmuch-search-toggle-hide-excluded and notmuch-tree-toggle-exclude have also been added. They toggle the value of notmuch-search-hide-excluded for the search in the current search or tree buffer. It's bound to "i" in the respective keymaps for these modes. Lastly I've amended some calls to notmuch-tree and notmuch-unthreaded which didn't pass through the buffer local value of notmuch-search-oldest-first (and now notmuch-search-exclude). Examples of where I've done this include: + notmuch-jump-search + notmuch-tree-from-search-current-query + notmuch-unthreaded-from-search-current-query + notmuch-tree-from-search-thread A new test file for Emacs has been added which covers the usage of the new `notmuch-search-hide-excluded' option and interactively hiding or showing mail with excluded tags. These test cover the basic usage of the `notmuch-search-toggle-hide-excluded' command in notmuch-search, notmuch-tree and notmuch-unthreaded searches. These tests also cover the persistence of the current value of the hide-excluded mail option as a user switches from between these different search commands. [1]: id:87ilxlxsng.fsf@kisara.moe Amended-by: db, fix indentation in T461-emacs-search-exclude.sh
2023-04-13doc: fix typosJakub Wilk
2023-02-20emacs: notmuch-tree-outline-modejao
With this mode, one can fold trees in the notmuch-tree buffer as if they were outlines, using all the commands provided by outline-minor-mode. We also define a couple of movement commands that, optional, will ensure that only the thread around point is unfolded. The implementation is based on registering a :level property in the messages p-list, that is then used by outline-minor-mode to to recognise headers. Amended by db: Copy docstring to manual and edit for presentation. Add two tests. Fix typo "wether".
2022-08-11doc/emacs: use define-key instead of hard-coding markupDavid Bremner
Add keys to index. Allow indexing of both keys and commands. Use standard typesetting for multiple keybindings.
2022-08-11doc/emacs: replace use of emacsvar with el:defcustomDavid Bremner
Mainly this allows dropping the ad-hoc directive emacsvar
2022-08-11doc/emacs: replace emacscmd with el:define-keyDavid Bremner
This allows us to eliminate the ad-hoc emacscmd directive / role, and improve indexing. doc/emacs: convert remaining uses of emacscmd to define-key This allows us to remove the no-longer used object type.
2022-08-11doc: add some documentation about duplicate files.David Bremner
This is mainly motivated by the new emacs-UI features to select duplicates, but hopefully it will help demystify things for users of the CLI as well.
2022-07-30doc/emacs: add docstring for notmuch-unthreaded-result-format.David Bremner
The main change is actually updating cross references.
2022-07-30doc/emacs: add docstring and example for n-tree-result-formatDavid Bremner
This example is based on one originally by Jon Hurst.
2022-07-30doc/emacs: add docstring and example for n-search-result-formatDavid Bremner
When the ability to use functions was added, this example was confined to a commit message, which is not user discoverable.
2022-07-15doc/emacs: add notmuch-show-empty-saved-searches to manualDavid Bremner
Answering a user question, I had to dig for this variable, but I think it is a reasonably common customization wish, particularly for users with custom count-functions.
2022-07-15doc/emacs: define and use emacsvar and emacscmd markupDavid Bremner
This makes it easier to navigate the merged index of all of the notmuch documentation.
2022-07-14doc: retitle notmuch-emacs manualDavid Bremner
This makes the HTML TOC read more naturally. Add a label to make cross referencing easier.
2022-07-14doc/emacs: add discussion about notmuch-show performance.David Bremner
Most of the information is already in the docstrings, but hopefully by grouping it is more discoverable.
2022-07-14emacs/show: introduce notmuch-show-height-limitDavid Bremner
Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-07-14emacs/show: obey notmuch-show-max-text-part-size for part 0David Bremner
This parameter was originally introduced to hide large attachements that happened to be text/plain. From a performance point of view, there is no reason not to also hide large message bodies.
2022-07-14emacs/show: optionally insert bodies of "deep messages" lazilyDavid Bremner
This leverages the machinery already there to insert buttons for attachments. A potential use-case is browsing the top layers of the tree to decide which of the lower subtrees to read.
2022-06-16emacs: use message-dont-reply-to-names when composing repliesjao
notmuch-mua functions for replies now use the built-in customizable variable message-dont-reply-to-names with the same semantics as message-mode.
2022-05-29doc/emacs: document a few notmuch-hello customizable variables.David Bremner
A user asked about the thousands separator on IRC, and I had to check the source.
2022-05-20emacs: document/defcustom notmuch-multipart/alternative-discouragedDavid Bremner
This variable is important for people who want to change the default behaviour when displaying multipart/alternative messages. Previously it was undocumented. Add a defcustom to help users and copy some documentation from the wiki. The usual machinery of re-using docstrings is a bit tricky to use here because it mangles the example lisp code, and the link to the info node should not be in e.g. the html page. Add a simple test to make sure the switch from defvar to defcustom did not break something obvious.
2022-05-15doc/emacs: document notmuch-show-toggle-toggle-elide-non-matchingDavid Bremner
Recently there was a question on the mailing list about the existence of this function, so let us try to make it more discoverable.
2022-02-26emacs: Document undo binding.David Bremner
This messes up whitespace, which will require a global change to fix.
2022-02-26emacs: add notmuch-tag-undoDavid Bremner
Keybindings are deferred to a future commit.
2022-02-25doc/emacs: add minimal documentation for notmuch-unthreaded mode.David Bremner
If nothing else it means the mode is discoverable by browsing the documentation, and also provides a target for links when enumerating modes.
2022-01-23emacs: customizable names for search buffersjao
Customizable names for buffers presenting search results, via two custom variables (notmuch-search-buffer-name-format and notmuch-saved-search-buffer-name-format), defaulting to values currently used for plain searches and including too tree and unthreaded search buffers. Amended by db: spelling fix.
2022-01-10emacs: make header line in notmuch-show buffers optionaljao
New notmuch-show-header-line customizable boolean to allow inhibiting a header line in notmuch-show-mode buffers (for instance, because one prefers to just include Subject in notmuch-message-headers).
2021-12-03emacs: drop C-tab binding in hello mode, document <backtab>.David Bremner
The <backtab> binding has always been there, but the docs were apparently mistakenly changed to say <backspace> [1] Revert to <backtab> in the documentation. The commit also drops the C-<tab> binding, since it seems redundant and it interferes with tab-bar-mode. [1]: 703dec7754da477b5683867c88cb940b8553be91.
2021-08-22doc/emacs: use :code: for some missing referencesDavid Bremner
It's not obvious how to reference (non-notmuch) emacs variables and functions in a sphinx document.
2021-08-21emacs: new command notmuch-tree-filter-by-tagjao
This new command for notmuch-tree-mode is analogous to notmuch-search-filter-by-tag, bound to "t" in notmuch-search-mode; it gets therefore the same "t" keybinding in notmuch-tree-mode (replacing the current assignment to notmuch-search-by-tag).
2021-08-21emacs: new command notmuch-tree-filterjao
This command is analogous to notmuch-filter, but is defined on tree mode buffers.
2021-07-03doc: new notmuch show --sort and related emacs commandsjao
New --sort CLI option documented in notmuch-show's man page, and notmuch-search-toggle-order mentioned in doc/notmuch-emacs.rst and devel/emacs-keybindings.org (in the latter, there's also some whitespace changes in a table introduced by org-mode).
2021-06-04emacs: drop setting mail-user-agent, and document how to set itDavid Bremner
After some discussion [1], I decided it is better to make notmuch users who rely on this behaviour customize mail-user-agent. This is consistent with the behaviour of other emacs mail packages. [1]: id:87k0nuhfrk.fsf@toryanderson.com
2021-05-19doc: fix variable name in documentationLuis Henriques
Variable 'notmuch-saved-searches-sort-function' does not exist; 'notmuch-saved-search-sort-function' is the correct name. Signed-off-by: Luis Henriques <henrix@camandro.org>
2020-06-01doc: fix for out-of-tree builds of notmuch-emacs docsDavid Bremner
The sphinx-doc include directive does not have the ability to include files from the build tree, so we replace the include with reading the files in conf.py. The non-trivial downside of this is that the emacs docstrings are now defined for every rst source file. They are namespaced with docstring::, so hopefully there will not be any surprises. One thing that is noticable is a small (absolute) time penalty in running sphinx-doc.
2019-03-27doc: Clean up warnings when building notmuch-emacs docsDaniel Kahn Gillmor
Without this change, we see this during the build: sphinx-build -b html -d doc/_build/doctrees -q ./doc doc/_build/html …/doc/notmuch-emacs.rst:67: WARNING: Unexpected indentation. …/doc/notmuch-emacs.rst:165: WARNING: Unexpected indentation. …/doc/notmuch-emacs.rst:306: WARNING: Unexpected indentation. This source change doesn't seem to have any effect on the generated HTML, at least. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-02-21Emacs: bind "g" to 'notuch-refresh-this-bufferMatt Armstrong
Using "g" for refresh operations is a pretty common Emacs convention, codified by `special-mode' in simple.el.
2018-12-08doc/emacs: document notmuch-cycle-notmuch-buffersDavid Bremner
For some reason I couldn't find this when I searched, so add it to the manual.
2018-12-08doc/emacs: document notmuch-poll*David Bremner
The current "documentation" for these variables consists of only the variable names.
2018-12-08doc/emacs: document notmuch-tagging-keysDavid Bremner
Calling these "Global keys" is arguably a bit of a stretch, but they do work in all notmuch modes except notmuch-hello.
2018-12-08doc/emacs: document notmuch-message-headers*David Bremner
More precisely, copy the docstrings into notmuch-emacs documentation pages.
2018-12-08doc/emacs: add documentation for stashing 'c X' bindingsDavid Bremner
This is the first of a series of changes requiring the extracted docstrings.
2018-05-26docs: add initial documentation for notmuch-tag-jumpDavid Bremner
This is mainly to improve discoverability. It seems that doing variable cross-references is not easy without using some sphinx extension/customization.
2018-05-26doc: initial documentation for notmuch-tree modeDavid Bremner
2018-05-26doc: initial documentation for notmuch-show-modeDavid Bremner
This is pretty minimal, but will hopefully inspire others to contribute more complete documentation. If nothing else, it points out '?'.
2016-11-17doc: fix references in notmuch-emacs.rstJani Nikula
Fix make sphinx-texinfo warnings: WARNING: undefined label: notmuch-jump (if the link has no caption the label must precede a section header) WARNING: undefined label: notmuch-saved-searches (if the link has no caption the label must precede a section header)
2016-06-11doc/notmuch-emacs.rst: update notmuch-hello buffer help textTomi Ollila
To look the same as commit b8a136187a3b changed it in emacs MUA code.