doc: use manpage role references to external man pages

[notmuch] / doc / man1 / notmuch-search.rst

diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst
index 181058c6d7a19d156d0e9ca2e033b696153b5002..ee9d4118246474b61d7059158202710595f1bb2d 100644 (file)
--- 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
 ``--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
 
 ``--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
 
     **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
 
     **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
 
     **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
 
         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
         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
 
     **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
 
 ``--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
 
 ``--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.
 
     terms. This option specifies whether to omit excluded messages in
     the search process.
 


@@ -146,9 +146,9 @@ message having multiple filenames.
 ::
 
   % notmuch search date:today.. and tag:bad-news
 ::
 
   % 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
 ===========
 
 EXIT STATUS
 ===========