debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-23 11:28:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add some documentation about duplicate files.

Browse source 
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.
This commit is contained in:
David Bremner 2022-07-30 20:45:51 -03:00
parent 5a47b5a884
commit bf64c48855
2 changed files with 42 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/man1/notmuch.rst
View file

@ -155,6 +155,23 @@ equivalent:
notmuch --config:alt-config config get user.name notmuch --config:alt-config config get user.name
notmuch --config alt-config config get user.name notmuch --config alt-config config get user.name
.. _duplicate-files:
DUPLICATE MESSAGE FILES
=======================
Notmuch considers the :mailheader:`Message-ID` to be the primary
identifier of message. Per :rfc:`5322` the :mailheader:`Message-ID` is
supposed to be globally unique, but this fails in two distinct
ways. When you receive copies of a message via a mechanism like
:mailheader:`Cc` or via a mailing list, the copies are typically
interchangeable. In the case of some broken mail sending software, the
same :mailheader:`Message-ID` is used for completely unrelated
messages. The options :option:`search --duplicate` and :option:`show
--duplicate` options provide the user with control over which message
file is displayed. Front ends will need to provide their own
interface, see e.g. the Emacs front-end :any:`emacs-show-duplicates`.
ENVIRONMENT ENVIRONMENT
=========== ===========

25
doc/notmuch-emacs.rst
View file

@ -431,6 +431,31 @@ in :ref:`notmuch-search`.
``c ?`` ``c ?``
Show all available copying commands Show all available copying commands
.. _emacs-show-duplicates:
Dealing with duplicates
-----------------------
If there are are multiple files with the same :mailheader:`Message-ID`
(see :any:`duplicate-files`), then :any:`notmuch-show` displays the
number of duplicates and identifies the current duplicate. In the
following example duplicate 3 of 5 is displayed.
.. code-block::
:emphasize-lines: 1
M. Mustermann <max@example.com> (Sat, 30 Jul 2022 10:33:10 -0300) (inbox signed) 3/5
Subject: Re: Multiple files per message in emacs
To: notmuch@notmuchmail.org
To display a different message file with the same
:mailheader:`Message-ID`, the user can run the command
:emacscmd:`notmuch-show-choose-duplicate`, by default bound to `%`.
.. emacscmd:: notmuch-show-choose-duplicate
|docstring::notmuch-show-choose-duplicate|
.. _notmuch-tree: .. _notmuch-tree:
notmuch-tree notmuch-tree