man: document notmuch address --deduplicate=address option

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

diff --git a/doc/man1/notmuch-address.rst b/doc/man1/notmuch-address.rst
index d349237353fd9db01d0f5058f51530d428567ab4..935851ef9ac32e1fcda8b3719749c44d80d8de0e 100644 (file)
--- a/doc/man1/notmuch-address.rst
+++ b/doc/man1/notmuch-address.rst
@@ -11,7 +11,7 @@ DESCRIPTION
 ===========
 
 Search for messages matching the given search terms, and display the
 ===========
 
 Search for messages matching the given search terms, and display the

-addresses from them.
+addresses from them. Duplicate addresses are filtered out.

 
 See **notmuch-search-terms(7)** for details of the supported syntax for
 <search-terms>.
 
 See **notmuch-search-terms(7)** for details of the supported syntax for
 <search-terms>.


@@ -29,25 +29,54 @@ Supported options for **address** include
         intended for programs that invoke **notmuch(1)** internally. If
         omitted, the latest supported version will be used.
 
         intended for programs that invoke **notmuch(1)** internally. If
         omitted, the latest supported version will be used.
 

-    ``--output=(sender|recipients)``
+    ``--output=(sender|recipients|count)``

 
         Controls which information appears in the output. This option
 
         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.
+
+            Note: With this option, addresses are printed only after
+            the whole search is finished. This may take long time.
+
+    ``--deduplicate=(no|mailbox|address)``
+
+        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.
+
+        **address**
+            Deduplicate addresses based on the case insensitive
+            address part of the mailbox. Of all the variants (with
+            different name or case), print the one occurring most
+            frequently among the matching messages. If --output=count
+            is specified, include all variants in the count.
+

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


@@ -56,6 +85,8 @@ 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 is not supported with --output=count.
+

     ``--exclude=(true|false)``
         A message is called "excluded" if it matches at least one tag in
         search.tag\_exclude that does not appear explicitly in the
     ``--exclude=(true|false)``
         A message is called "excluded" if it matches at least one tag in
         search.tag\_exclude that does not appear explicitly in the


@@ -86,4 +117,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)**