X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-address.rst;h=9eae65cbae8f4644e7a446a5bf54aa6d0db8986c;hb=ff4e81ac57dee5a62f35093c2966f931a7b7580c;hp=c00d7d743e3e45a0b6111457b28b00140dedc4a8;hpb=5d510221d17862a252955d98046508bebcd14573;p=notmuch diff --git a/doc/man1/notmuch-address.rst b/doc/man1/notmuch-address.rst index c00d7d74..9eae65cb 100644 --- a/doc/man1/notmuch-address.rst +++ b/doc/man1/notmuch-address.rst @@ -1,3 +1,5 @@ +.. _notmuch-address(1): + =============== notmuch-address =============== @@ -13,7 +15,7 @@ DESCRIPTION Search for messages matching the given search terms, and display the addresses from them. Duplicate addresses are filtered out. -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 **address** include @@ -21,19 +23,19 @@ Supported options for **address** 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=(sender|recipients|count|address)`` Controls which information appears in the output. This option can be given multiple times to combine different outputs. When - neither --output=sender nor --output=recipients is - given, --output=sender is implied. + neither ``--output=sender`` nor ``--output=recipients`` is + given, ``--output=sender`` is implied. **sender** Output all addresses from the *From* header. @@ -63,19 +65,19 @@ Supported options for **address** include **no** Output all occurrences of addresses in the matching - messages. This is not applicable with --output=count. + messages. This is not applicable with ``--output=count``. **mailbox** Deduplicate addresses based on the full, case sensitive name and email address, or mailbox. This is effectively the same as - piping the --deduplicate=no output to **sort | uniq**, except + piping the ``--deduplicate=no`` output to **sort | uniq**, except for the order of results. This is the default. **address** Deduplicate addresses based on the case insensitive address part of the mailbox. Of all the variants (with different name or case), print the one occurring most frequently among the - matching messages. If --output=count is specified, include all + matching messages. If ``--output=count`` is specified, include all variants in the count. ``--sort=``\ (**newest-first**\ \|\ **oldest-first**) @@ -86,13 +88,13 @@ Supported options for **address** include By default, results will be displayed in reverse chronological order, (that is, the newest results will be displayed first). - However, if either --output=count or --deduplicate=address is + However, if either ``--output=count`` or ``--deduplicate=address`` is specified, this option is ignored and the order of the results is unspecified. ``--exclude=(true|false)`` 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. @@ -116,16 +118,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-search(1)** +:any:`notmuch(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(1)`, +:any:`notmuch-search-terms(7)`, +:any:`notmuch-show(1)`, +:any:`notmuch-tag(1)`