]> git.notmuchmail.org Git - notmuch/commitdiff
doc: mark `--output=summary` as default
authorMichael J Gruber <git@grubix.eu>
Wed, 30 Nov 2022 13:58:34 +0000 (14:58 +0100)
committerDavid Bremner <david@tethera.net>
Sat, 3 Dec 2022 13:32:48 +0000 (09:32 -0400)
`notmuch search` behaves differently depending on the output option: It
either outputs information pertaining to all threads with matching
messages (summary, threads) or to all matching messages (messages,
files, tags). The man page refres solely to the former in the main
description.

Help the user by clearly marking `summary` as the default output option.

Signed-off-by: Michael J Gruber <git@grubix.eu>
doc/man1/notmuch-search.rst

index ad305efdb6a07a2ff2635c618da21fcce2c9ad9d..b87737ea3bd0ae4b2ba0ec10a0a7014cc971ff2b 100644 (file)
@@ -43,7 +43,7 @@ Supported options for **search** include
 
 .. option:: --output=(summary|threads|messages|files|tags)
 
-   summary
+   summary (default)
      Output a summary of each thread with any message matching the
      search terms. The summary includes the thread ID, date, the
      number of messages in the thread (both the number matched and