X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-search.rst;h=689f027ab3df5e97820d768845787406d5cd1535;hb=ff4e81ac57dee5a62f35093c2966f931a7b7580c;hp=181058c6d7a19d156d0e9ca2e033b696153b5002;hpb=963ccabe93b0564e6979433f5be34395e9aa8ef1;p=notmuch diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst index 181058c6..689f027a 100644 --- a/doc/man1/notmuch-search.rst +++ b/doc/man1/notmuch-search.rst @@ -1,3 +1,5 @@ +.. _notmuch-search(1): + ============== notmuch-search ============== @@ -19,7 +21,7 @@ in the thread, the number of matched messages and total messages in the thread, the names of all participants in the thread, and the subject of the newest (or oldest) message. -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 **search** include @@ -27,12 +29,12 @@ Supported options for **search** include ``--format=``\ (**json**\ \|\ **sexp**\ \|\ **text**\ \|\ **text0**) Presents the results in either JSON, S-Expressions, newline character separated plain-text (default), or null character - separated plain-text (compatible with **xargs(1)** -0 option where - available). + separated plain-text (compatible with :manpage:`xargs(1)` -0 + option where available). ``--format-version=N`` Use the specified structured output format version. This is - intended for programs that invoke **notmuch(1)** internally. If + intended for programs that invoke :any:`notmuch(1)` internally. If omitted, the latest supported version will be used. ``--output=(summary|threads|messages|files|tags)`` @@ -47,25 +49,25 @@ Supported options for **search** include **threads** Output the thread IDs of all threads with any message matching - the search terms, either one per line (--format=text), - separated by null characters (--format=text0), as a JSON array - (--format=json), or an S-Expression list (--format=sexp). + the search terms, either one per line (``--format=text``), + separated by null characters (``--format=text0``), as a JSON array + (``--format=json``), or an S-Expression list (``--format=sexp``). **messages** Output the message IDs of all messages matching the search - terms, either one per line (--format=text), separated by null - characters (--format=text0), as a JSON array (--format=json), - or as an S-Expression list (--format=sexp). + terms, either one per line (``--format=text``), separated by null + characters (``--format=text0``), as a JSON array (``--format=json``), + or as an S-Expression list (``--format=sexp``). **files** Output the filenames of all messages matching the search - terms, either one per line (--format=text), separated by null - characters (--format=text0), as a JSON array (--format=json), - or as an S-Expression list (--format=sexp). + terms, either one per line (``--format=text``), separated by null + characters (``--format=text0``), as a JSON array (``--format=json``), + or as an S-Expression list (``--format=sexp``). Note that each message may have multiple filenames associated with it. All of them are included in the output (unless - limited with the --duplicate=N option). This may be + limited with the ``--duplicate=N`` option). This may be particularly confusing for **folder:** or **path:** searches in a specified directory, as the messages may have duplicates in other directories that are included in the output, although @@ -73,9 +75,9 @@ Supported options for **search** include **tags** Output all tags that appear on any message matching the search - terms, either one per line (--format=text), separated by null - characters (--format=text0), as a JSON array (--format=json), - or as an S-Expression list (--format=sexp). + terms, either one per line (``--format=text``), separated by null + characters (``--format=text0``), as a JSON array (``--format=json``), + or as an S-Expression list (``--format=sexp``). ``--sort=``\ (**newest-first**\ \|\ **oldest-first**) This option can be used to present results in either chronological @@ -100,7 +102,7 @@ Supported options for **search** include ``--exclude=(true|false|all|flag)`` A message is called "excluded" if it matches at least one tag in - search.tag\_exclude that does not appear explicitly in the search + search.exclude\_tags that does not appear explicitly in the search terms. This option specifies whether to omit excluded messages in the search process. @@ -146,9 +148,9 @@ 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) + thread:0000000000063c10 Today [1/1] Some Persun; To the bone (bad-news inbox unread) + thread:0000000000063c25 Today [1/1(2)] Ann Other; Bears (bad-news inbox unread) + thread:0000000000063c00 Today [1/1] A Thurd; Bites, stings, sad feelings (bad-news unread) EXIT STATUS =========== @@ -164,16 +166,16 @@ This command supports the following special exit status codes SEE ALSO ======== -**notmuch(1)**, -**notmuch-config(1)**, -**notmuch-count(1)**, -**notmuch-dump(1)**, -**notmuch-hooks(5)**, -**notmuch-insert(1)**, -**notmuch-new(1)**, -**notmuch-reply(1)**, -**notmuch-restore(1)**, -**notmuch-search-terms(7)**, -**notmuch-show(1)**, -**notmuch-tag(1)** -**notmuch-address(1)** +:any:`notmuch(1)`, +:any:`notmuch-address(1)` +:any:`notmuch-config(1)`, +:any:`notmuch-count(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-terms(7)`, +:any:`notmuch-show(1)`, +:any:`notmuch-tag(1)`