man: document notmuch address --deduplicate=(no|mailbox) option

[notmuch] / doc / man1 / notmuch-address.rst

diff --git a/doc/man1/notmuch-address.rst b/doc/man1/notmuch-address.rst
index 359616e0dc5f70215794a448a388a04075ced8b9..6003ed29cf32a913c6bf54138f496970574b514e 100644 (file)
--- a/doc/man1/notmuch-address.rst
+++ b/doc/man1/notmuch-address.rst
@@ -32,28 +32,43 @@ Supported options for **address** include
     ``--output=(sender|recipients|count)``
 
         Controls which information appears in the output. This option
     ``--output=(sender|recipients|count)``
 
         Controls which information appears in the output. This option

-       can be given multiple times to combine different outputs.
-       Omitting this option is equivalent to
-       --output=sender --output=recipients.
+        can be given multiple times to combine different outputs.
+        When neither --output=sender nor --output=recipients is
+        given, --output=sender is implied.

 
 

-       **sender**
+        **sender**

             Output all addresses from the *From* header.
 
             Output all addresses from the *From* header.
 

-           Note: Searching for **sender** should be much faster than
-           searching for **recipients**, because sender addresses are
-           cached directly in the database whereas other addresses
-           need to be fetched from message files.
+            Note: Searching for **sender** should be much faster than
+            searching for **recipients**, because sender addresses are
+            cached directly in the database whereas other addresses
+            need to be fetched from message files.

 
 

-       **recipients**
+        **recipients**

             Output all addresses from the *To*, *Cc* and *Bcc*
             headers.
 
             Output all addresses from the *To*, *Cc* and *Bcc*
             headers.
 

-       **count**
-           Print the count of how many times was the address
-           encountered during search.
+        **count**
+            Print the count of how many times was the address
+            encountered during search.

 
 

-           Note: With this option, addresses are printed only after
-           the whole search is finished. This may take long time.
+            Note: With this option, addresses are printed only after
+            the whole search is finished. This may take long time.
+
+    ``--deduplicate=(no|mailbox)``
+
+        Control the deduplication of results.
+
+        **no**
+            Output all occurences of addresses in the matching
+            messages. This is not applicable with --output=count.
+
+        **mailbox**
+           Deduplicate addresses based on the full, case sensitive
+           name and email address, or mailbox. This is effectively
+           the same as piping the --deduplicate=no output to **sort |
+           uniq**, except for the order of results. This is the
+           default.

 
     ``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
         This option can be used to present results in either
 
     ``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
         This option can be used to present results in either


@@ -63,7 +78,7 @@ Supported options for **address** include
         By default, results will be displayed in reverse chronological
         order, (that is, the newest results will be displayed first).
 
         By default, results will be displayed in reverse chronological
         order, (that is, the newest results will be displayed first).
 

-       This option has no effect when used with --output=count.
+        This option is not supported with --output=count.

 
     ``--exclude=(true|false)``
         A message is called "excluded" if it matches at least one tag in
 
     ``--exclude=(true|false)``
         A message is called "excluded" if it matches at least one tag in


@@ -95,4 +110,4 @@ SEE ALSO
 **notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
 **notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-restore(1)**,
 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**,
 **notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
 **notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-restore(1)**,
 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**,

-***notmuch-search(1)**
+**notmuch-search(1)**