X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-search.rst;h=ee9d4118246474b61d7059158202710595f1bb2d;hb=3baa61e0e58402bc50c5df529fcf669bf4b2facb;hp=e42da2aec65407a69c069995a2172569d728ea2e;hpb=045f0e455ac94e2393d0d729c9bbdf3459a4860f;p=notmuch diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst index e42da2ae..ee9d4118 100644 --- a/doc/man1/notmuch-search.rst +++ b/doc/man1/notmuch-search.rst @@ -27,8 +27,8 @@ 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 @@ -47,25 +47,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 +73,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 +100,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.