cli: add support for only printing the addresses in notmuch address

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

diff --git a/doc/man1/notmuch-address.rst b/doc/man1/notmuch-address.rst
index 935851ef9ac32e1fcda8b3719749c44d80d8de0e..68415d13c5b6b78c8fdba23566ff3bc667074bc1 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|count)``
+    ``--output=(sender|recipients|count|address)``

 
         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.


@@ -55,20 +55,25 @@ Supported options for **address** include
             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.
 

+        **address**
+            Output only the email addresses instead of the full
+            mailboxes with names and email addresses. This option has
+            no effect on the JSON or S-Expression output formats.
+

     ``--deduplicate=(no|mailbox|address)``
 
         Control the deduplication of results.
 
         **no**
     ``--deduplicate=(no|mailbox|address)``
 
         Control the deduplication of results.
 
         **no**

-            Output all occurences of addresses in the matching
+            Output all occurrences of addresses in the matching

             messages. This is not applicable with --output=count.
 
         **mailbox**
             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.
+            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**
             Deduplicate addresses based on the case insensitive


@@ -85,7 +90,9 @@ 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.
+        However, if either --output=count or --deduplicate=address is
+        specified, this option is ignored and the order of the results
+        is unspecified.

 
     ``--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


@@ -113,8 +120,16 @@ This command supports the following special exit status codes
 SEE ALSO
 ========
 
 SEE ALSO
 ========
 

-**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(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(1)**,
+**notmuch-config(1)**,
+**notmuch-count(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)**