]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch-count.rst
emacs: Add new option notmuch-search-hide-excluded
[notmuch] / doc / man1 / notmuch-count.rst
index 99de13a9871245af98f1ca55e8570179e116883e..4c9c9a1cb4d78ef47c1c03bff273d46481e8bf45 100644 (file)
@@ -1,3 +1,5 @@
+.. _notmuch-count(1):
+
 =============
 notmuch-count
 =============
@@ -17,49 +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
 <search-terms>.
 
 Supported options for **count** include
 
-    ``--output=(messages|threads|files)``
+.. 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)
 
-        **messages**
-            Output the number of matching messages. This is the default.
+   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=<filename>
 
-    ``--input=``\ <filename>
-        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)`