X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-count.rst;h=0eac5dbef4ba09242795cf14abc3de2affe96444;hp=9ca20dab274733ed0a049f83f55e5cd83b25951b;hb=HEAD;hpb=a727e7d4d398375c4a3ba5020e2ab25b5b874785 diff --git a/doc/man1/notmuch-count.rst b/doc/man1/notmuch-count.rst index 9ca20dab..4c9c9a1c 100644 --- a/doc/man1/notmuch-count.rst +++ b/doc/man1/notmuch-count.rst @@ -1,3 +1,5 @@ +.. _notmuch-count(1): + ============= notmuch-count ============= @@ -17,56 +19,63 @@ The number of matching messages (or threads) is output to stdout. With no search terms, a count of all messages (or threads) in the database will be displayed. -See **notmuch-search-terms(7)** for details of the supported syntax for +See :any:`notmuch-search-terms(7)` for details of the supported syntax for . Supported options for **count** include -``--output=(messages|threads|files)`` - **messages** - Output the number of matching messages. This is the default. +.. program:: count + +.. option:: --output=(messages|threads|files) + + messages + Output the number of matching messages. This is the default. + + threads + Output the number of matching threads. + + files + Output the number of files associated with matching + messages. This may be bigger than the number of matching + messages due to duplicates (i.e. multiple files having the + same message-id). + +.. option:: --exclude=(true|false) + + Specify whether to omit messages matching search.exclude\_tags from + the count (the default) or not. - **threads** - Output the number of matching threads. +.. option:: --batch - **files** - Output the number of files associated with matching - messages. This may be bigger than the number of matching - messages due to duplicates (i.e. multiple files having the - same message-id). + Read queries from a file (stdin by default), one per line, and + output the number of matching messages (or threads) to stdout, one + per line. On an empty input line the count of all messages (or + threads) in the database will be output. This option is not + compatible with specifying search terms on the command line. -``--exclude=(true|false)`` - Specify whether to omit messages matching search.tag\_exclude from - the count (the default) or not. +.. option:: --lastmod -``--batch`` - Read queries from a file (stdin by default), one per line, and - output the number of matching messages (or threads) to stdout, one - per line. On an empty input line the count of all messages (or - threads) in the database will be output. This option is not - compatible with specifying search terms on the command line. + Append lastmod (counter for number of database updates) and UUID + to the output. lastmod values are only comparable between + databases with the same UUID. -``--lastmod`` - Append lastmod (counter for number of database updates) and UUID - to the output. lastmod values are only comparable between - databases with the same UUID. +.. option:: --input= -``--input=``\ - Read input from given file, instead of from stdin. Implies - ``--batch``. + Read input from given file, instead of from stdin. Implies + ``--batch``. SEE ALSO ======== -**notmuch(1)**, -**notmuch-config(1)**, -**notmuch-dump(1)**, -**notmuch-hooks(5)**, -**notmuch-insert(1)**, -**notmuch-new(1)**, -**notmuch-reply(1)**, -**notmuch-restore(1)**, -**notmuch-search(1)**, -**notmuch-search-terms(7)**, -**notmuch-show(1)**, -**notmuch-tag(1)** +:any:`notmuch(1)`, +:any:`notmuch-config(1)`, +:any:`notmuch-dump(1)`, +:any:`notmuch-hooks(5)`, +:any:`notmuch-insert(1)`, +:any:`notmuch-new(1)`, +:any:`notmuch-reply(1)`, +:any:`notmuch-restore(1)`, +:any:`notmuch-search(1)`, +:any:`notmuch-search-terms(7)`, +:any:`notmuch-show(1)`, +:any:`notmuch-tag(1)`