cli: address: Add --output=count

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

diff --git a/doc/man1/notmuch-address.rst b/doc/man1/notmuch-address.rst
index 01eb811e3d29c9b4b4040acfa287051048045243..359616e0dc5f70215794a448a388a04075ced8b9 100644 (file)
--- a/doc/man1/notmuch-address.rst
+++ b/doc/man1/notmuch-address.rst
@@ -29,7 +29,7 @@ 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
        can be given multiple times to combine different outputs.
 
         Controls which information appears in the output. This option
        can be given multiple times to combine different outputs.


@@ -48,6 +48,13 @@ Supported options for **address** include
             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.
+

     ``--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 +63,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 has no effect when used 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