]> git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-count-1.mdwn
0.20.1 manpages update
[notmuch-wiki] / manpages / notmuch-count-1.mdwn
1 <h1>NOTMUCH-COUNT(1)</h1>
2
3 <h2>NAME</h2>
4 <pre>
5        notmuch-count - count messages matching the given search terms
6 </pre>
7
8 <h2>SYNOPSIS</h2>
9 <pre>
10        <b>notmuch</b> <b>count</b> [<u>option</u> ...] &lt;<u>search-term</u>&gt; ...
11 </pre>
12
13 <h2>DESCRIPTION</h2>
14 <pre>
15        Count messages matching the search terms.
16
17        The number of matching messages (or threads) is output to stdout.
18
19        With no search terms, a count of all messages (or threads) in the data‐
20        base will be displayed.
21
22        See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of  the  supported  syntax  for
23        &lt;search-terms&gt;.
24
25        Supported options for <b>count</b> include
26           <b>--output=(messages|threads|files)</b>
27
28               <b>messages</b>
29                      Output  the  number  of  matching  messages.  This is the
30                      default.
31
32               <b>threads</b>
33                      Output the number of matching threads.
34
35               <b>files</b>  Output the number of files associated with matching  mes‐
36                      sages.  This  may  be  bigger than the number of matching
37                      messages due to duplicates (i.e.  multiple  files  having
38                      the same message-id).
39
40           <b>--exclude=(true|false)</b>
41                  Specify  whether to omit messages matching search.tag_exclude
42                  from the count (the default) or not.
43
44           <b>--batch</b>
45                  Read queries from a file (stdin by default),  one  per  line,
46                  and  output  the  number of matching messages (or threads) to
47                  stdout, one per line. On an empty input line the count of all
48                  messages  (or  threads)  in the database will be output. This
49                  option is not compatible with specifying search terms on  the
50                  command line.
51
52           <b>--input=&lt;filename&gt;</b>
53                  Read  input  from  given file, instead of from stdin. Implies
54                  <b>--batch</b>.
55 </pre>
56
57 <h2>SEE ALSO</h2>
58 <pre>
59        <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5),  <a href='../notmuch-insert-1/'>not‐</a>
60        <a href='../notmuch-insert-1/'>much-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
61        <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not‐</a>
62        <a href='../notmuch-tag-1/'>much-tag</a>(1)
63 </pre>
64
65 <h2>AUTHOR</h2>
66 <pre>
67        Carl Worth and many others
68 </pre>
69
70 <h2>COPYRIGHT</h2>
71 <pre>
72        2014, Carl Worth and many others
73 </pre>
74
75 <h2>0.20.1</h2>