aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTomi Ollila <tomi.ollila@iki.fi>2014-11-07 20:31:50 +0200
committerDavid Bremner <david@tethera.net>2014-11-09 10:09:51 +0100
commit0d8251dbe236975e69b07de2aeb9b60df44d6929 (patch)
tree58c26f822086eb038e7a402b48728413652dd891 /doc
parent8e3ee13abc8f7e62557aaf862bbf6aa3e33f6d33 (diff)
cli: notmuch address option defaults update
When no --output option were given, change default to display senders only. When only --count option is given, display senders (in contrary to not displaying anything). Document that --count with --sort=**order** is not supported option combination. Clean up some whitespace in the documentation. One test updated to have --output=count without sender nor recipient output option.
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/notmuch-address.rst32
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/man1/notmuch-address.rst b/doc/man1/notmuch-address.rst
index 359616e0..9570095b 100644
--- a/doc/man1/notmuch-address.rst
+++ b/doc/man1/notmuch-address.rst
@@ -32,28 +32,28 @@ Supported options for **address** include
``--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.
- 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.
- **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.
``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
This option can be used to present results in either
@@ -63,7 +63,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).
- 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
@@ -95,4 +95,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-search(1)**
+**notmuch-search(1)**