git.notmuchmail.org Git - notmuch/blob - man/man1/notmuch-count.1

   1 .TH NOTMUCH-COUNT 1 2013-08-03 "Notmuch 0.16"
   2 .SH NAME
   3 notmuch-count \- count messages matching the given search terms
   4 .SH SYNOPSIS
   5
   6 .B notmuch count
   7 .RI  [ options "... ] <" search-term ">..."
   8
   9 .SH DESCRIPTION
  10
  11 Count messages matching the search terms.
  12
  13 The number of matching messages (or threads) is output to stdout.
  14
  15 With no search terms, a count of all messages (or threads) in the database will
  16 be displayed.
  17
  18 See \fBnotmuch-search-terms\fR(7)
  19 for details of the supported syntax for <search-terms>.
  20
  21 Supported options for
  22 .B count
  23 include
  24 .RS 4
  25 .TP 4
  26 .B \-\-output=(messages|threads|files)
  27
  28 .RS 4
  29 .TP 4
  30 .B messages
  31
  32 Output the number of matching messages. This is the default.
  33 .RE
  34 .RS 4
  35 .TP 4
  36 .B threads
  37
  38 Output the number of matching threads.
  39 .RE
  40 .RS 4
  41 .TP 4
  42 .B files
  43
  44 Output the number of files associated with matching messages. This may
  45 be bigger than the number of matching messages due to duplicates
  46 (i.e. multiple files having the same message-id).
  47 .RE
  48 .RE
  49
  50 .RS 4
  51 .TP 4
  52 .BR \-\-exclude=(true|false)
  53
  54 Specify whether to omit messages matching search.tag_exclude from the
  55 count (the default) or not.
  56 .RE
  57
  58 .RS 4
  59 .TP 4
  60 .BR \-\-batch
  61
  62 Read queries from a file (stdin by default), one per line, and output
  63 the number of matching messages (or threads) to stdout, one per
  64 line. On an empty input line the count of all messages (or threads) in
  65 the database will be output. This option is not compatible with
  66 specifying search terms on the command line.
  67 .RE
  68
  69 .RS 4
  70 .TP 4
  71 .BR "\-\-input=" <filename>
  72
  73 Read input from given file, instead of from stdin. Implies
  74 .BR --batch .
  75 .RE
  76
  77 .RE
  78 .RE
  79
  80 .SH SEE ALSO
  81
  82 \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-dump\fR(1),
  83 \fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
  84 \fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
  85 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
  86 \fBnotmuch-tag\fR(1)