[PATCH] doc: mark `--output=summary` as default

Subject: [PATCH] doc: mark `--output=summary` as default

Date: Wed, 30 Nov 2022 14:58:34 +0100

To: notmuch@notmuchmail.org

Cc: Michael J Gruber

From: michaeljgruber+grubix+git@gmail.com

From: Michael J Gruber <git@grubix.eu>

`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

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 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst
index ad305efd..b87737ea 100644
--- a/doc/man1/notmuch-search.rst
+++ b/doc/man1/notmuch-search.rst
@@ -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

notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org