summaryrefslogtreecommitdiffstats
path: root/doc/man1
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2017-06-04 09:32:32 -0300
committerDavid Bremner <david@tethera.net>2017-08-01 21:17:47 -0400
commited4a9082c02d0a73f5f7d07f90a7daf65bde0aaa (patch)
treeb4c5b09aedc4c24ae168066681ac3b8a3602e016 /doc/man1
parent50340bcb78586dc63b5e0914563665b30e8f88d0 (diff)
cli/search: print total number of files matched in summary output.
The structured output formats already have all of the filenames. This is an easy bit of UI change to make the multiple files visible.
Diffstat (limited to 'doc/man1')
-rw-r--r--doc/man1/notmuch-search.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst
index 4e660a6f..fd6dcadd 100644
--- a/doc/man1/notmuch-search.rst
+++ b/doc/man1/notmuch-search.rst
@@ -42,7 +42,9 @@ Supported options for **search** include
the search terms. The summary includes the thread ID, date,
the number of messages in the thread (both the number
matched and the total number), the authors of the thread and
- the subject.
+ the subject. In the case where a thread contains multiple files for
+ some messages, the total number of files is printed in parentheses
+ (see below for an example).
**threads**
Output the thread IDs of all threads with any message
@@ -135,6 +137,19 @@ Supported options for **search** include
prefix. The prefix matches messages based on filenames. This
option filters filenames of the matching messages.
+EXAMPLE
+=======
+
+The following shows an example of the summary output format, with one
+message having multiple filenames.
+
+::
+
+ % notmuch search date:today.. and tag:bad-news
+ thread:0000000000063c10 Today [1/1] Some Persun; To the bone (inbox unread)
+ thread:0000000000063c25 Today [1/1(2)] Ann Other; Bears (inbox unread)
+ thread:0000000000063c00 Today [1/1] A Thurd; Bites, stings, sad feelings (inbox unread)
+
EXIT STATUS
===========